From ae7243d42b035cc62d10cde7d35740ed7a5297af Mon Sep 17 00:00:00 2001 From: "apix-bot[bot]" <168195273+apix-bot[bot]@users.noreply.github.com> Date: Fri, 23 May 2025 11:57:00 +0200 Subject: [PATCH] Project import generated by Copybara. GitOrigin-RevId: e6e6fbf7c177b8c8cf62c7474065c420afb17169 --- source/command/atlas-accessLists-create.txt | 8 +- source/command/atlas-accessLists-delete.txt | 8 +- source/command/atlas-accessLists-describe.txt | 8 +- source/command/atlas-accessLists-list.txt | 8 +- source/command/atlas-accessLists.txt | 10 +- source/command/atlas-accessLogs-list.txt | 5 + source/command/atlas-accessLogs.txt | 10 +- source/command/atlas-alerts-acknowledge.txt | 9 ++ source/command/atlas-alerts-describe.txt | 5 + source/command/atlas-alerts-list.txt | 5 + .../command/atlas-alerts-settings-create.txt | 8 +- .../command/atlas-alerts-settings-delete.txt | 8 +- .../atlas-alerts-settings-describe.txt | 8 +- .../command/atlas-alerts-settings-disable.txt | 10 +- .../command/atlas-alerts-settings-enable.txt | 10 +- .../atlas-alerts-settings-fields-type.txt | 8 +- .../command/atlas-alerts-settings-fields.txt | 7 ++ source/command/atlas-alerts-settings-list.txt | 8 +- .../command/atlas-alerts-settings-update.txt | 8 +- source/command/atlas-alerts-settings.txt | 8 +- source/command/atlas-alerts-unacknowledge.txt | 5 + source/command/atlas-alerts.txt | 10 +- ...ssTracking-listAccessLogsByClusterName.txt | 21 ++-- ...ccessTracking-listAccessLogsByHostname.txt | 21 ++-- source/command/atlas-api-accessTracking.txt | 11 +- ...onfigurations-createAlertConfiguration.txt | 15 ++- ...onfigurations-deleteAlertConfiguration.txt | 23 ++-- ...rtConfigurations-getAlertConfiguration.txt | 23 ++-- ...stAlertConfigurationMatchersFieldNames.txt | 24 ++-- ...Configurations-listAlertConfigurations.txt | 21 ++-- ...tions-listAlertConfigurationsByAlertId.txt | 23 ++-- ...onfigurations-toggleAlertConfiguration.txt | 17 ++- ...onfigurations-updateAlertConfiguration.txt | 17 ++- .../command/atlas-api-alertConfigurations.txt | 23 ++-- .../atlas-api-alerts-acknowledgeAlert.txt | 17 ++- source/command/atlas-api-alerts-getAlert.txt | 23 ++-- .../command/atlas-api-alerts-listAlerts.txt | 21 ++-- ...lerts-listAlertsByAlertConfigurationId.txt | 23 ++-- source/command/atlas-api-alerts.txt | 15 ++- ...tlasSearch-createAtlasSearchDeployment.txt | 13 +- ...api-atlasSearch-createAtlasSearchIndex.txt | 15 ++- ...earch-createAtlasSearchIndexDeprecated.txt | 15 ++- ...tlasSearch-deleteAtlasSearchDeployment.txt | 19 +-- ...api-atlasSearch-deleteAtlasSearchIndex.txt | 21 ++-- ...lasSearch-deleteAtlasSearchIndexByName.txt | 21 ++-- ...earch-deleteAtlasSearchIndexDeprecated.txt | 21 ++-- ...i-atlasSearch-getAtlasSearchDeployment.txt | 19 +-- ...as-api-atlasSearch-getAtlasSearchIndex.txt | 19 +-- ...-atlasSearch-getAtlasSearchIndexByName.txt | 19 +-- ...asSearch-getAtlasSearchIndexDeprecated.txt | 21 ++-- ...api-atlasSearch-listAtlasSearchIndexes.txt | 21 ++-- ...asSearch-listAtlasSearchIndexesCluster.txt | 21 ++-- ...earch-listAtlasSearchIndexesDeprecated.txt | 21 ++-- ...tlasSearch-updateAtlasSearchDeployment.txt | 13 +- ...api-atlasSearch-updateAtlasSearchIndex.txt | 15 ++- ...lasSearch-updateAtlasSearchIndexByName.txt | 15 ++- ...earch-updateAtlasSearchIndexDeprecated.txt | 15 ++- source/command/atlas-api-atlasSearch.txt | 43 ++++--- ...-api-auditing-getAuditingConfiguration.txt | 21 ++-- ...i-auditing-updateAuditingConfiguration.txt | 15 ++- source/command/atlas-api-auditing.txt | 13 +- ...las-api-awsClustersDns-getAwsCustomDns.txt | 21 ++-- ...-api-awsClustersDns-toggleAwsCustomDns.txt | 15 ++- source/command/atlas-api-awsClustersDns.txt | 11 +- ...pi-cloudBackups-cancelBackupRestoreJob.txt | 21 ++-- ...api-cloudBackups-createBackupExportJob.txt | 13 +- ...pi-cloudBackups-createBackupRestoreJob.txt | 15 ++- ...as-api-cloudBackups-createExportBucket.txt | 74 ++++++++---- ...ckups-createServerlessBackupRestoreJob.txt | 15 ++- ...-cloudBackups-deleteAllBackupSchedules.txt | 19 +-- ...as-api-cloudBackups-deleteExportBucket.txt | 19 +-- ...pi-cloudBackups-deleteReplicaSetBackup.txt | 21 ++-- ...loudBackups-deleteShardedClusterBackup.txt | 21 ++-- ...dBackups-disableDataProtectionSettings.txt | 21 ++-- ...as-api-cloudBackups-getBackupExportJob.txt | 19 +-- ...s-api-cloudBackups-getBackupRestoreJob.txt | 21 ++-- ...las-api-cloudBackups-getBackupSchedule.txt | 21 ++-- ...cloudBackups-getDataProtectionSettings.txt | 21 ++-- ...atlas-api-cloudBackups-getExportBucket.txt | 19 +-- ...s-api-cloudBackups-getReplicaSetBackup.txt | 21 ++-- ...s-api-cloudBackups-getServerlessBackup.txt | 19 +-- ...dBackups-getServerlessBackupRestoreJob.txt | 21 ++-- ...i-cloudBackups-getShardedClusterBackup.txt | 21 ++-- ...-api-cloudBackups-listBackupExportJobs.txt | 21 ++-- ...api-cloudBackups-listBackupRestoreJobs.txt | 21 ++-- ...las-api-cloudBackups-listExportBuckets.txt | 21 ++-- ...api-cloudBackups-listReplicaSetBackups.txt | 21 ++-- ...ackups-listServerlessBackupRestoreJobs.txt | 21 ++-- ...api-cloudBackups-listServerlessBackups.txt | 21 ++-- ...cloudBackups-listShardedClusterBackups.txt | 21 ++-- .../atlas-api-cloudBackups-takeSnapshot.txt | 15 ++- ...-api-cloudBackups-updateBackupSchedule.txt | 15 ++- ...udBackups-updateDataProtectionSettings.txt | 15 ++- ...i-cloudBackups-updateSnapshotRetention.txt | 13 +- source/command/atlas-api-cloudBackups.txt | 67 ++++++----- ...-cloudMigrationService-createLinkToken.txt | 13 +- ...udMigrationService-createPushMigration.txt | 13 +- ...cloudMigrationService-cutoverMigration.txt | 19 +-- ...-cloudMigrationService-deleteLinkToken.txt | 17 +-- ...cloudMigrationService-getPushMigration.txt | 19 +-- ...udMigrationService-getValidationStatus.txt | 17 +-- ...oudMigrationService-listSourceProjects.txt | 19 +-- ...loudMigrationService-validateMigration.txt | 13 +- .../atlas-api-cloudMigrationService.txt | 23 ++-- ...ccess-authorizeCloudProviderAccessRole.txt | 15 ++- ...erAccess-createCloudProviderAccessRole.txt | 15 ++- ...ess-deauthorizeCloudProviderAccessRole.txt | 21 ++-- ...viderAccess-getCloudProviderAccessRole.txt | 21 ++-- ...derAccess-listCloudProviderAccessRoles.txt | 21 ++-- .../command/atlas-api-cloudProviderAccess.txt | 19 ++- ...erOutageSimulation-endOutageSimulation.txt | 19 +-- ...erOutageSimulation-getOutageSimulation.txt | 19 +-- ...OutageSimulation-startOutageSimulation.txt | 13 +- .../atlas-api-clusterOutageSimulation.txt | 15 ++- ...-api-clusters-autoScalingConfiguration.txt | 19 +-- .../atlas-api-clusters-createCluster.txt | 48 ++++---- .../atlas-api-clusters-deleteCluster.txt | 24 ++-- .../command/atlas-api-clusters-getCluster.txt | 24 ++-- ...usters-getClusterAdvancedConfiguration.txt | 21 ++-- .../atlas-api-clusters-getClusterStatus.txt | 21 ++-- ...pi-clusters-getSampleDatasetLoadStatus.txt | 19 +-- ...pi-clusters-grantMongoDbEmployeeAccess.txt | 13 +- ...-api-clusters-listCloudProviderRegions.txt | 21 ++-- .../atlas-api-clusters-listClusters.txt | 24 ++-- ...pi-clusters-listClustersForAllProjects.txt | 26 ++-- .../atlas-api-clusters-loadSampleDataset.txt | 19 +-- ...lusters-pinFeatureCompatibilityVersion.txt | 13 +- ...i-clusters-revokeMongoDbEmployeeAccess.txt | 19 +-- .../atlas-api-clusters-testFailover.txt | 21 ++-- ...sters-unpinFeatureCompatibilityVersion.txt | 19 +-- .../atlas-api-clusters-updateCluster.txt | 27 +++-- ...ers-updateClusterAdvancedConfiguration.txt | 15 ++- ...tlas-api-clusters-upgradeSharedCluster.txt | 15 ++- source/command/atlas-api-clusters.txt | 45 +++---- ...atsLatencyNamespaceClusterMeasurements.txt | 17 +-- ...lStatsLatencyNamespaceHostMeasurements.txt | 17 +-- ...cs-getCollStatsLatencyNamespaceMetrics.txt | 17 +-- ...etCollStatsLatencyNamespacesForCluster.txt | 17 +-- ...s-getCollStatsLatencyNamespacesForHost.txt | 17 +-- ...ectionLevelMetrics-getPinnedNamespaces.txt | 17 +-- ...lectionLevelMetrics-pinNamespacesPatch.txt | 11 +- ...ollectionLevelMetrics-pinNamespacesPut.txt | 11 +- ...collectionLevelMetrics-unpinNamespaces.txt | 11 +- .../atlas-api-collectionLevelMetrics.txt | 29 ++--- ...DatabaseRoles-createCustomDatabaseRole.txt | 15 ++- ...DatabaseRoles-deleteCustomDatabaseRole.txt | 21 ++-- ...tomDatabaseRoles-getCustomDatabaseRole.txt | 21 ++-- ...mDatabaseRoles-listCustomDatabaseRoles.txt | 21 ++-- ...DatabaseRoles-updateCustomDatabaseRole.txt | 15 ++- .../command/atlas-api-customDatabaseRoles.txt | 17 ++- ...on-createDataFederationPrivateEndpoint.txt | 15 ++- ...dataFederation-createFederatedDatabase.txt | 15 ++- ...tion-createOneDataFederationQueryLimit.txt | 13 +- ...on-deleteDataFederationPrivateEndpoint.txt | 21 ++-- ...dataFederation-deleteFederatedDatabase.txt | 21 ++-- ...eteOneDataFederationInstanceQueryLimit.txt | 19 +-- ...ion-downloadFederatedDatabaseQueryLogs.txt | 17 +-- ...ation-getDataFederationPrivateEndpoint.txt | 21 ++-- ...pi-dataFederation-getFederatedDatabase.txt | 19 +-- ...ion-listDataFederationPrivateEndpoints.txt | 21 ++-- ...-dataFederation-listFederatedDatabases.txt | 21 ++-- ...tion-returnFederatedDatabaseQueryLimit.txt | 21 ++-- ...ion-returnFederatedDatabaseQueryLimits.txt | 21 ++-- ...dataFederation-updateFederatedDatabase.txt | 15 ++- source/command/atlas-api-dataFederation.txt | 35 +++--- ...s-api-dataLakePipelines-createPipeline.txt | 11 +- ...s-api-dataLakePipelines-deletePipeline.txt | 17 +-- ...LakePipelines-deletePipelineRunDataset.txt | 19 +-- ...tlas-api-dataLakePipelines-getPipeline.txt | 21 ++-- ...s-api-dataLakePipelines-getPipelineRun.txt | 21 ++-- ...api-dataLakePipelines-listPipelineRuns.txt | 21 ++-- ...ataLakePipelines-listPipelineSchedules.txt | 21 ++-- ...ataLakePipelines-listPipelineSnapshots.txt | 21 ++-- ...as-api-dataLakePipelines-listPipelines.txt | 19 +-- ...as-api-dataLakePipelines-pausePipeline.txt | 21 ++-- ...s-api-dataLakePipelines-resumePipeline.txt | 21 ++-- ...LakePipelines-triggerSnapshotIngestion.txt | 13 +- ...s-api-dataLakePipelines-updatePipeline.txt | 11 +- .../command/atlas-api-dataLakePipelines.txt | 35 +++--- ...s-api-databaseUsers-createDatabaseUser.txt | 78 ++++++------ ...s-api-databaseUsers-deleteDatabaseUser.txt | 23 ++-- ...tlas-api-databaseUsers-getDatabaseUser.txt | 23 ++-- ...as-api-databaseUsers-listDatabaseUsers.txt | 21 ++-- ...s-api-databaseUsers-updateDatabaseUser.txt | 17 ++- source/command/atlas-api-databaseUsers.txt | 19 ++- ...-createEncryptionAtRestPrivateEndpoint.txt | 13 +- ...tomerKeyManagement-getEncryptionAtRest.txt | 21 ++-- ...ent-getEncryptionAtRestPrivateEndpoint.txt | 19 +-- ...AtRestPrivateEndpointsForCloudProvider.txt | 19 +-- ...ncryptionAtRestPrivateEndpointDeletion.txt | 19 +-- ...erKeyManagement-updateEncryptionAtRest.txt | 15 ++- ...yptionAtRestUsingCustomerKeyManagement.txt | 19 +-- .../atlas-api-events-getOrganizationEvent.txt | 23 ++-- .../atlas-api-events-getProjectEvent.txt | 23 ++-- .../atlas-api-events-listEventTypes.txt | 24 ++-- ...tlas-api-events-listOrganizationEvents.txt | 21 ++-- .../atlas-api-events-listProjectEvents.txt | 21 ++-- source/command/atlas-api-events.txt | 17 ++- ...dAuthentication-createIdentityProvider.txt | 13 +- ...eratedAuthentication-createRoleMapping.txt | 13 +- ...atedAuthentication-deleteFederationApp.txt | 17 +-- ...dAuthentication-deleteIdentityProvider.txt | 21 ++-- ...eratedAuthentication-deleteRoleMapping.txt | 19 +-- ...edAuthentication-getConnectedOrgConfig.txt | 19 +-- ...edAuthentication-getFederationSettings.txt | 21 ++-- ...atedAuthentication-getIdentityProvider.txt | 19 +-- ...entication-getIdentityProviderMetadata.txt | 17 +-- ...federatedAuthentication-getRoleMapping.txt | 19 +-- ...Authentication-listConnectedOrgConfigs.txt | 19 +-- ...edAuthentication-listIdentityProviders.txt | 19 +-- ...deratedAuthentication-listRoleMappings.txt | 19 +-- ...uthentication-removeConnectedOrgConfig.txt | 19 +-- ...ication-revokeJwksFromIdentityProvider.txt | 21 ++-- ...uthentication-updateConnectedOrgConfig.txt | 13 +- ...dAuthentication-updateIdentityProvider.txt | 13 +- ...eratedAuthentication-updateRoleMapping.txt | 13 +- .../atlas-api-federatedAuthentication.txt | 45 ++++--- ...las-api-flexClusters-createFlexCluster.txt | 15 ++- ...las-api-flexClusters-deleteFlexCluster.txt | 21 ++-- .../atlas-api-flexClusters-getFlexCluster.txt | 21 ++-- ...tlas-api-flexClusters-listFlexClusters.txt | 21 ++-- ...las-api-flexClusters-updateFlexCluster.txt | 15 ++- ...as-api-flexClusters-upgradeFlexCluster.txt | 15 ++- source/command/atlas-api-flexClusters.txt | 21 ++-- ...RestoreJobs-createFlexBackupRestoreJob.txt | 15 ++- ...lexRestoreJobs-getFlexBackupRestoreJob.txt | 21 ++-- ...xRestoreJobs-listFlexBackupRestoreJobs.txt | 21 ++-- source/command/atlas-api-flexRestoreJobs.txt | 15 ++- ...s-api-flexSnapshots-downloadFlexBackup.txt | 15 ++- .../atlas-api-flexSnapshots-getFlexBackup.txt | 19 +-- ...tlas-api-flexSnapshots-listFlexBackups.txt | 21 ++-- source/command/atlas-api-flexSnapshots.txt | 15 ++- ...globalClusters-createCustomZoneMapping.txt | 15 ++- ...-globalClusters-createManagedNamespace.txt | 15 ++- ...alClusters-deleteAllCustomZoneMappings.txt | 21 ++-- ...-globalClusters-deleteManagedNamespace.txt | 21 ++-- ...api-globalClusters-getManagedNamespace.txt | 21 ++-- source/command/atlas-api-globalClusters.txt | 17 ++- ...nvoices-createCostExplorerQueryProcess.txt | 11 +- .../atlas-api-invoices-downloadInvoiceCsv.txt | 21 ++-- ...i-invoices-getCostExplorerQueryProcess.txt | 17 +-- .../command/atlas-api-invoices-getInvoice.txt | 21 ++-- .../atlas-api-invoices-listInvoices.txt | 21 ++-- ...atlas-api-invoices-listPendingInvoices.txt | 21 ++-- ...voices-queryLineItemsFromSingleInvoice.txt | 11 +- source/command/atlas-api-invoices.txt | 23 ++-- ...pConfiguration-deleteLdapConfiguration.txt | 21 ++-- ...ldapConfiguration-getLdapConfiguration.txt | 21 ++-- ...nfiguration-getLdapConfigurationStatus.txt | 23 ++-- ...dapConfiguration-saveLdapConfiguration.txt | 15 ++- ...pConfiguration-verifyLdapConfiguration.txt | 15 ++- .../command/atlas-api-ldapConfiguration.txt | 17 ++- ...acyBackup-createLegacyBackupRestoreJob.txt | 15 ++- ...-api-legacyBackup-deleteLegacySnapshot.txt | 21 ++-- ...legacyBackup-getLegacyBackupCheckpoint.txt | 21 ++-- ...legacyBackup-getLegacyBackupRestoreJob.txt | 21 ++-- ...las-api-legacyBackup-getLegacySnapshot.txt | 21 ++-- ...legacyBackup-getLegacySnapshotSchedule.txt | 21 ++-- ...gacyBackup-listLegacyBackupCheckpoints.txt | 21 ++-- ...gacyBackup-listLegacyBackupRestoreJobs.txt | 21 ++-- ...s-api-legacyBackup-listLegacySnapshots.txt | 21 ++-- ...cyBackup-updateLegacySnapshotRetention.txt | 15 ++- ...acyBackup-updateLegacySnapshotSchedule.txt | 15 ++- source/command/atlas-api-legacyBackup.txt | 31 +++-- ...ntenanceWindows-deferMaintenanceWindow.txt | 19 +-- ...aintenanceWindows-getMaintenanceWindow.txt | 21 ++-- ...ntenanceWindows-resetMaintenanceWindow.txt | 19 +-- ...anceWindows-toggleMaintenanceAutoDefer.txt | 19 +-- ...tenanceWindows-updateMaintenanceWindow.txt | 13 +- .../command/atlas-api-maintenanceWindows.txt | 17 ++- ...-mongoDbCloudUsers-addOrganizationRole.txt | 15 ++- ...s-api-mongoDbCloudUsers-addProjectRole.txt | 15 ++- ...s-api-mongoDbCloudUsers-addProjectUser.txt | 15 ++- ...as-api-mongoDbCloudUsers-addUserToTeam.txt | 15 ++- ...ngoDbCloudUsers-createOrganizationUser.txt | 15 ++- ...atlas-api-mongoDbCloudUsers-createUser.txt | 15 ++- ...-mongoDbCloudUsers-getOrganizationUser.txt | 21 ++-- ...s-api-mongoDbCloudUsers-getProjectUser.txt | 21 ++-- .../atlas-api-mongoDbCloudUsers-getUser.txt | 26 ++-- ...pi-mongoDbCloudUsers-getUserByUsername.txt | 26 ++-- ...ongoDbCloudUsers-listOrganizationUsers.txt | 21 ++-- ...api-mongoDbCloudUsers-listProjectUsers.txt | 21 ++-- ...as-api-mongoDbCloudUsers-listTeamUsers.txt | 21 ++-- ...ngoDbCloudUsers-removeOrganizationRole.txt | 15 ++- ...ngoDbCloudUsers-removeOrganizationUser.txt | 21 ++-- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 15 ++- ...pi-mongoDbCloudUsers-removeProjectUser.txt | 21 ++-- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 15 ++- ...ngoDbCloudUsers-updateOrganizationUser.txt | 15 ++- .../command/atlas-api-mongoDbCloudUsers.txt | 47 ++++---- ...-api-monitoringAndLogs-getAtlasProcess.txt | 21 ++-- ...tlas-api-monitoringAndLogs-getDatabase.txt | 21 ++-- ...itoringAndLogs-getDatabaseMeasurements.txt | 21 ++-- ...-monitoringAndLogs-getDiskMeasurements.txt | 21 ++-- ...tlas-api-monitoringAndLogs-getHostLogs.txt | 22 ++-- ...-monitoringAndLogs-getHostMeasurements.txt | 21 ++-- ...-api-monitoringAndLogs-getIndexMetrics.txt | 17 +-- ...-api-monitoringAndLogs-getMeasurements.txt | 17 +-- ...i-monitoringAndLogs-listAtlasProcesses.txt | 24 ++-- ...as-api-monitoringAndLogs-listDatabases.txt | 21 ++-- ...monitoringAndLogs-listDiskMeasurements.txt | 19 +-- ...i-monitoringAndLogs-listDiskPartitions.txt | 21 ++-- ...api-monitoringAndLogs-listIndexMetrics.txt | 17 +-- ...-api-monitoringAndLogs-listMetricTypes.txt | 17 +-- .../command/atlas-api-monitoringAndLogs.txt | 37 +++--- ...networkPeering-createPeeringConnection.txt | 15 ++- ...-networkPeering-createPeeringContainer.txt | 15 ++- ...networkPeering-deletePeeringConnection.txt | 21 ++-- ...-networkPeering-deletePeeringContainer.txt | 21 ++-- ...tlas-api-networkPeering-disablePeering.txt | 15 ++- ...pi-networkPeering-getPeeringConnection.txt | 21 ++-- ...api-networkPeering-getPeeringContainer.txt | 21 ++-- ...-networkPeering-listPeeringConnections.txt | 21 ++-- ...ng-listPeeringContainerByCloudProvider.txt | 21 ++-- ...i-networkPeering-listPeeringContainers.txt | 21 ++-- ...networkPeering-updatePeeringConnection.txt | 15 ++- ...-networkPeering-updatePeeringContainer.txt | 15 ++- ...ConnectViaPeeringOnlyModeForOneProject.txt | 21 ++-- source/command/atlas-api-networkPeering.txt | 33 +++--- ...-api-onlineArchive-createOnlineArchive.txt | 15 ++- ...-api-onlineArchive-deleteOnlineArchive.txt | 21 ++-- ...Archive-downloadOnlineArchiveQueryLogs.txt | 19 +-- ...las-api-onlineArchive-getOnlineArchive.txt | 21 ++-- ...s-api-onlineArchive-listOnlineArchives.txt | 21 ++-- ...-api-onlineArchive-updateOnlineArchive.txt | 15 ++- source/command/atlas-api-onlineArchive.txt | 21 ++-- ...s-api-organizations-createOrganization.txt | 15 ++- ...nizations-createOrganizationInvitation.txt | 15 ++- ...s-api-organizations-deleteOrganization.txt | 19 +-- ...nizations-deleteOrganizationInvitation.txt | 21 ++-- ...tlas-api-organizations-getOrganization.txt | 21 ++-- ...rganizations-getOrganizationInvitation.txt | 19 +-- ...-organizations-getOrganizationSettings.txt | 21 ++-- ...anizations-listOrganizationInvitations.txt | 21 ++-- ...organizations-listOrganizationProjects.txt | 21 ++-- ...as-api-organizations-listOrganizations.txt | 26 ++-- ...s-api-organizations-updateOrganization.txt | 15 ++- ...nizations-updateOrganizationInvitation.txt | 13 +- ...tions-updateOrganizationInvitationById.txt | 13 +- ...-organizations-updateOrganizationRoles.txt | 15 ++- ...ganizations-updateOrganizationSettings.txt | 15 ++- source/command/atlas-api-organizations.txt | 39 +++--- ...visor-disableSlowOperationThresholding.txt | 21 ++-- ...dvisor-enableSlowOperationThresholding.txt | 21 ++-- ...pi-performanceAdvisor-getManagedSlowMs.txt | 19 +-- ...manceAdvisor-getServerlessAutoIndexing.txt | 19 +-- ...nceAdvisor-listClusterSuggestedIndexes.txt | 19 +-- ...api-performanceAdvisor-listDropIndexes.txt | 17 +-- ...pi-performanceAdvisor-listSchemaAdvice.txt | 17 +-- ...api-performanceAdvisor-listSlowQueries.txt | 35 ++++-- ...ormanceAdvisor-listSlowQueryNamespaces.txt | 21 ++-- ...erformanceAdvisor-listSuggestedIndexes.txt | 23 ++-- ...manceAdvisor-setServerlessAutoIndexing.txt | 19 +-- .../command/atlas-api-performanceAdvisor.txt | 29 +++-- ...EndpointServices-createPrivateEndpoint.txt | 15 ++- ...tServices-createPrivateEndpointService.txt | 15 ++- ...EndpointServices-deletePrivateEndpoint.txt | 21 ++-- ...tServices-deletePrivateEndpointService.txt | 21 ++-- ...ateEndpointServices-getPrivateEndpoint.txt | 21 ++-- ...ointServices-getPrivateEndpointService.txt | 21 ++-- ...-getRegionalizedPrivateEndpointSetting.txt | 21 ++-- ...ntServices-listPrivateEndpointServices.txt | 21 ++-- ...ggleRegionalizedPrivateEndpointSetting.txt | 15 ++- .../atlas-api-privateEndpointServices.txt | 27 +++-- ...i-programmaticApiKeys-addProjectApiKey.txt | 15 ++- ...s-api-programmaticApiKeys-createApiKey.txt | 15 ++- ...rammaticApiKeys-createApiKeyAccessList.txt | 15 ++- ...rogrammaticApiKeys-createProjectApiKey.txt | 15 ++- ...s-api-programmaticApiKeys-deleteApiKey.txt | 21 ++-- ...ticApiKeys-deleteApiKeyAccessListEntry.txt | 21 ++-- ...tlas-api-programmaticApiKeys-getApiKey.txt | 21 ++-- ...rogrammaticApiKeys-getApiKeyAccessList.txt | 21 ++-- ...icApiKeys-listApiKeyAccessListsEntries.txt | 21 ++-- ...as-api-programmaticApiKeys-listApiKeys.txt | 21 ++-- ...programmaticApiKeys-listProjectApiKeys.txt | 21 ++-- ...rogrammaticApiKeys-removeProjectApiKey.txt | 21 ++-- ...s-api-programmaticApiKeys-updateApiKey.txt | 13 +- ...-programmaticApiKeys-updateApiKeyRoles.txt | 13 +- .../command/atlas-api-programmaticApiKeys.txt | 35 +++--- ...IpAccessList-createProjectIpAccessList.txt | 27 +++-- ...IpAccessList-deleteProjectIpAccessList.txt | 24 ++-- ...ccessList-getProjectIpAccessListStatus.txt | 22 ++-- ...i-projectIpAccessList-getProjectIpList.txt | 24 ++-- ...tIpAccessList-listProjectIpAccessLists.txt | 24 ++-- .../command/atlas-api-projectIpAccessList.txt | 17 ++- .../atlas-api-projects-addUserToProject.txt | 15 ++- .../atlas-api-projects-createProject.txt | 27 +++-- ...s-api-projects-createProjectInvitation.txt | 15 ++- .../atlas-api-projects-deleteProject.txt | 24 ++-- ...s-api-projects-deleteProjectInvitation.txt | 19 +-- .../atlas-api-projects-deleteProjectLimit.txt | 21 ++-- .../command/atlas-api-projects-getProject.txt | 24 ++-- .../atlas-api-projects-getProjectByName.txt | 24 ++-- ...tlas-api-projects-getProjectInvitation.txt | 21 ++-- .../atlas-api-projects-getProjectLimit.txt | 21 ++-- ...las-api-projects-getProjectLtsVersions.txt | 19 +-- .../atlas-api-projects-getProjectSettings.txt | 21 ++-- ...as-api-projects-listProjectInvitations.txt | 21 ++-- .../atlas-api-projects-listProjectLimits.txt | 21 ++-- .../atlas-api-projects-listProjects.txt | 24 ++-- ...pi-projects-migrateProjectToAnotherOrg.txt | 13 +- ...tlas-api-projects-returnAllIpAddresses.txt | 21 ++-- .../atlas-api-projects-setProjectLimit.txt | 15 ++- .../atlas-api-projects-updateProject.txt | 27 +++-- ...s-api-projects-updateProjectInvitation.txt | 13 +- ...i-projects-updateProjectInvitationById.txt | 11 +- .../atlas-api-projects-updateProjectRoles.txt | 15 ++- ...las-api-projects-updateProjectSettings.txt | 15 ++- source/command/atlas-api-projects.txt | 55 +++++---- ...Export-createPushBasedLogConfiguration.txt | 13 +- ...Export-deletePushBasedLogConfiguration.txt | 19 +-- ...LogExport-getPushBasedLogConfiguration.txt | 19 +-- ...Export-updatePushBasedLogConfiguration.txt | 13 +- .../command/atlas-api-pushBasedLogExport.txt | 15 ++- ...urcePolicies-createAtlasResourcePolicy.txt | 13 +- ...urcePolicies-deleteAtlasResourcePolicy.txt | 19 +-- ...ourcePolicies-getAtlasResourcePolicies.txt | 19 +-- ...esourcePolicies-getAtlasResourcePolicy.txt | 19 +-- ...ourcePolicies-getResourcesNonCompliant.txt | 19 +-- ...urcePolicies-updateAtlasResourcePolicy.txt | 13 +- ...cePolicies-validateAtlasResourcePolicy.txt | 13 +- source/command/atlas-api-resourcePolicies.txt | 23 ++-- ...as-api-rollingIndex-createRollingIndex.txt | 48 ++++---- source/command/atlas-api-rollingIndex.txt | 9 +- .../atlas-api-root-getSystemStatus.txt | 24 ++-- ...-root-returnAllControlPlaneIpAddresses.txt | 22 ++-- source/command/atlas-api-root.txt | 11 +- ...lessInstances-createServerlessInstance.txt | 15 ++- ...lessInstances-deleteServerlessInstance.txt | 21 ++-- ...verlessInstances-getServerlessInstance.txt | 21 ++-- ...rlessInstances-listServerlessInstances.txt | 21 ++-- ...lessInstances-updateServerlessInstance.txt | 15 ++- .../command/atlas-api-serverlessInstances.txt | 19 ++- ...points-createServerlessPrivateEndpoint.txt | 13 +- ...points-deleteServerlessPrivateEndpoint.txt | 19 +-- ...Endpoints-getServerlessPrivateEndpoint.txt | 17 +-- ...dpoints-listServerlessPrivateEndpoints.txt | 17 +-- ...points-updateServerlessPrivateEndpoint.txt | 13 +- .../atlas-api-serverlessPrivateEndpoints.txt | 17 ++- ...rviceAccounts-addProjectServiceAccount.txt | 13 +- ...ceAccounts-createProjectServiceAccount.txt | 15 ++- ...-createProjectServiceAccountAccessList.txt | 15 ++- ...unts-createProjectServiceAccountSecret.txt | 13 +- ...i-serviceAccounts-createServiceAccount.txt | 13 +- ...ccounts-createServiceAccountAccessList.txt | 15 ++- ...iceAccounts-createServiceAccountSecret.txt | 13 +- ...ceAccounts-deleteProjectServiceAccount.txt | 21 ++-- ...teProjectServiceAccountAccessListEntry.txt | 21 ++-- ...unts-deleteProjectServiceAccountSecret.txt | 19 +-- ...i-serviceAccounts-deleteServiceAccount.txt | 19 +-- ...ts-deleteServiceAccountAccessListEntry.txt | 21 ++-- ...iceAccounts-deleteServiceAccountSecret.txt | 19 +-- ...rviceAccounts-getProjectServiceAccount.txt | 19 +-- ...-api-serviceAccounts-getServiceAccount.txt | 19 +-- ...ts-listProjectServiceAccountAccessList.txt | 19 +-- ...iceAccounts-listProjectServiceAccounts.txt | 19 +-- ...eAccounts-listServiceAccountAccessList.txt | 19 +-- ...iceAccounts-listServiceAccountProjects.txt | 19 +-- ...pi-serviceAccounts-listServiceAccounts.txt | 19 +-- ...ceAccounts-updateProjectServiceAccount.txt | 13 +- ...i-serviceAccounts-updateServiceAccount.txt | 13 +- source/command/atlas-api-serviceAccounts.txt | 53 +++++---- ...bs-createSharedClusterBackupRestoreJob.txt | 15 ++- ...eJobs-getSharedClusterBackupRestoreJob.txt | 21 ++-- ...obs-listSharedClusterBackupRestoreJobs.txt | 21 ++-- .../atlas-api-sharedTierRestoreJobs.txt | 15 ++- ...rSnapshots-downloadSharedClusterBackup.txt | 15 ++- ...edTierSnapshots-getSharedClusterBackup.txt | 21 ++-- ...TierSnapshots-listSharedClusterBackups.txt | 21 ++-- .../command/atlas-api-sharedTierSnapshots.txt | 15 ++- ...api-streams-acceptVpcPeeringConnection.txt | 11 +- ...pi-streams-createPrivateLinkConnection.txt | 15 ++- ...las-api-streams-createStreamConnection.txt | 15 ++- ...atlas-api-streams-createStreamInstance.txt | 15 ++- ...ateStreamInstanceWithSampleConnections.txt | 15 ++- ...tlas-api-streams-createStreamProcessor.txt | 15 ++- ...pi-streams-deletePrivateLinkConnection.txt | 21 ++-- ...las-api-streams-deleteStreamConnection.txt | 21 ++-- ...atlas-api-streams-deleteStreamInstance.txt | 21 ++-- ...tlas-api-streams-deleteStreamProcessor.txt | 21 ++-- ...api-streams-deleteVpcPeeringConnection.txt | 17 +-- ...-streams-downloadStreamTenantAuditLogs.txt | 19 +-- .../atlas-api-streams-getAccountDetails.txt | 17 +-- ...streams-getActiveVpcPeeringConnections.txt | 19 +-- ...s-api-streams-getPrivateLinkConnection.txt | 19 +-- .../atlas-api-streams-getStreamConnection.txt | 19 +-- .../atlas-api-streams-getStreamInstance.txt | 19 +-- .../atlas-api-streams-getStreamProcessor.txt | 21 ++-- ...s-api-streams-getVpcPeeringConnections.txt | 19 +-- ...api-streams-listPrivateLinkConnections.txt | 19 +-- ...tlas-api-streams-listStreamConnections.txt | 19 +-- .../atlas-api-streams-listStreamInstances.txt | 19 +-- ...atlas-api-streams-listStreamProcessors.txt | 21 ++-- ...tlas-api-streams-modifyStreamProcessor.txt | 15 ++- ...api-streams-rejectVpcPeeringConnection.txt | 17 +-- ...atlas-api-streams-startStreamProcessor.txt | 21 ++-- ...s-api-streams-startStreamProcessorWith.txt | 107 +++++++++++++++++ .../atlas-api-streams-stopStreamProcessor.txt | 21 ++-- ...las-api-streams-updateStreamConnection.txt | 15 ++- ...atlas-api-streams-updateStreamInstance.txt | 15 ++- source/command/atlas-api-streams.txt | 67 ++++++----- .../atlas-api-teams-addAllTeamsToProject.txt | 13 +- .../command/atlas-api-teams-addTeamUser.txt | 15 ++- source/command/atlas-api-teams-createTeam.txt | 15 ++- source/command/atlas-api-teams-deleteTeam.txt | 21 ++-- .../command/atlas-api-teams-getTeamById.txt | 21 ++-- .../command/atlas-api-teams-getTeamByName.txt | 21 ++-- .../atlas-api-teams-listOrganizationTeams.txt | 21 ++-- .../atlas-api-teams-listProjectTeams.txt | 21 ++-- .../atlas-api-teams-removeProjectTeam.txt | 19 +-- .../atlas-api-teams-removeTeamUser.txt | 21 ++-- source/command/atlas-api-teams-renameTeam.txt | 15 ++- .../atlas-api-teams-updateTeamRoles.txt | 15 ++- source/command/atlas-api-teams.txt | 33 ++++-- ...tegrations-createThirdPartyIntegration.txt | 15 ++- ...tegrations-deleteThirdPartyIntegration.txt | 21 ++-- ...yIntegrations-getThirdPartyIntegration.txt | 21 ++-- ...ntegrations-listThirdPartyIntegrations.txt | 21 ++-- ...tegrations-updateThirdPartyIntegration.txt | 15 ++- .../atlas-api-thirdPartyIntegrations.txt | 17 ++- ...tication-createDatabaseUserCertificate.txt | 15 ++- ...hentication-disableCustomerManagedX509.txt | 17 +-- ...ntication-listDatabaseUserCertificates.txt | 21 ++-- .../command/atlas-api-x509Authentication.txt | 13 +- source/command/atlas-api.txt | 112 +++++++++--------- source/command/atlas-auditing-describe.txt | 5 + source/command/atlas-auditing-update.txt | 8 +- source/command/atlas-auditing.txt | 10 +- source/command/atlas-auth-login.txt | 10 +- source/command/atlas-auth-logout.txt | 10 +- source/command/atlas-auth-register.txt | 10 +- source/command/atlas-auth-whoami.txt | 10 +- source/command/atlas-auth.txt | 10 +- ...ompliancePolicy-copyProtection-disable.txt | 7 ++ ...compliancePolicy-copyProtection-enable.txt | 7 ++ ...ackups-compliancePolicy-copyProtection.txt | 7 ++ ...tlas-backups-compliancePolicy-describe.txt | 7 ++ .../atlas-backups-compliancePolicy-enable.txt | 7 ++ ...pliancePolicy-encryptionAtRest-disable.txt | 7 ++ ...mpliancePolicy-encryptionAtRest-enable.txt | 7 ++ ...kups-compliancePolicy-encryptionAtRest.txt | 7 ++ ...iancePolicy-pointInTimeRestores-enable.txt | 7 ++ ...s-compliancePolicy-pointInTimeRestores.txt | 7 ++ ...ups-compliancePolicy-policies-describe.txt | 7 ++ ...pliancePolicy-policies-ondemand-create.txt | 7 ++ ...iancePolicy-policies-ondemand-describe.txt | 7 ++ ...pliancePolicy-policies-ondemand-update.txt | 7 ++ ...ups-compliancePolicy-policies-ondemand.txt | 7 ++ ...liancePolicy-policies-scheduled-create.txt | 7 ++ ...ancePolicy-policies-scheduled-describe.txt | 7 ++ ...ps-compliancePolicy-policies-scheduled.txt | 7 ++ ...tlas-backups-compliancePolicy-policies.txt | 7 ++ .../atlas-backups-compliancePolicy-setup.txt | 7 ++ .../atlas-backups-compliancePolicy.txt | 10 +- .../atlas-backups-exports-buckets-create.txt | 8 +- .../atlas-backups-exports-buckets-delete.txt | 8 +- ...atlas-backups-exports-buckets-describe.txt | 8 +- .../atlas-backups-exports-buckets-list.txt | 8 +- .../command/atlas-backups-exports-buckets.txt | 7 ++ .../atlas-backups-exports-jobs-create.txt | 8 +- .../atlas-backups-exports-jobs-describe.txt | 8 +- .../atlas-backups-exports-jobs-list.txt | 8 +- .../atlas-backups-exports-jobs-watch.txt | 8 +- source/command/atlas-backups-exports-jobs.txt | 7 ++ source/command/atlas-backups-exports.txt | 7 ++ .../atlas-backups-restores-describe.txt | 8 +- .../command/atlas-backups-restores-list.txt | 5 + .../command/atlas-backups-restores-start.txt | 5 + .../command/atlas-backups-restores-watch.txt | 8 +- source/command/atlas-backups-restores.txt | 10 +- .../command/atlas-backups-schedule-delete.txt | 8 +- .../atlas-backups-schedule-describe.txt | 8 +- .../command/atlas-backups-schedule-update.txt | 8 +- source/command/atlas-backups-schedule.txt | 7 ++ .../atlas-backups-snapshots-create.txt | 8 +- .../atlas-backups-snapshots-delete.txt | 5 + .../atlas-backups-snapshots-describe.txt | 5 + .../atlas-backups-snapshots-download.txt | 5 + .../command/atlas-backups-snapshots-list.txt | 5 + .../command/atlas-backups-snapshots-watch.txt | 5 + source/command/atlas-backups-snapshots.txt | 7 ++ source/command/atlas-backups.txt | 10 +- ...oudProviders-accessRoles-aws-authorize.txt | 7 ++ ...-cloudProviders-accessRoles-aws-create.txt | 5 + ...dProviders-accessRoles-aws-deauthorize.txt | 5 + .../atlas-cloudProviders-accessRoles-aws.txt | 7 ++ .../atlas-cloudProviders-accessRoles-list.txt | 5 + .../atlas-cloudProviders-accessRoles.txt | 7 ++ source/command/atlas-cloudProviders.txt | 10 +- ...las-clusters-advancedSettings-describe.txt | 8 +- ...atlas-clusters-advancedSettings-update.txt | 8 +- .../atlas-clusters-advancedSettings.txt | 7 ++ .../atlas-clusters-availableRegions-list.txt | 10 +- .../atlas-clusters-availableRegions.txt | 7 ++ ...as-clusters-connectionStrings-describe.txt | 8 +- .../atlas-clusters-connectionStrings.txt | 7 ++ source/command/atlas-clusters-create.txt | 8 +- source/command/atlas-clusters-delete.txt | 8 +- source/command/atlas-clusters-describe.txt | 8 +- source/command/atlas-clusters-failover.txt | 8 +- .../command/atlas-clusters-indexes-create.txt | 8 +- source/command/atlas-clusters-indexes.txt | 7 ++ source/command/atlas-clusters-list.txt | 8 +- .../atlas-clusters-onlineArchives-create.txt | 8 +- .../atlas-clusters-onlineArchives-delete.txt | 5 + ...atlas-clusters-onlineArchives-describe.txt | 5 + .../atlas-clusters-onlineArchives-list.txt | 5 + .../atlas-clusters-onlineArchives-pause.txt | 5 + .../atlas-clusters-onlineArchives-start.txt | 5 + .../atlas-clusters-onlineArchives-update.txt | 8 +- .../atlas-clusters-onlineArchives-watch.txt | 5 + .../command/atlas-clusters-onlineArchives.txt | 7 ++ source/command/atlas-clusters-pause.txt | 8 +- .../atlas-clusters-sampleData-describe.txt | 8 +- .../atlas-clusters-sampleData-load.txt | 8 +- .../atlas-clusters-sampleData-watch.txt | 8 +- source/command/atlas-clusters-sampleData.txt | 8 +- .../atlas-clusters-search-indexes-create.txt | 8 +- .../atlas-clusters-search-indexes-delete.txt | 5 + ...atlas-clusters-search-indexes-describe.txt | 8 +- .../atlas-clusters-search-indexes-list.txt | 8 +- .../atlas-clusters-search-indexes-update.txt | 5 + .../command/atlas-clusters-search-indexes.txt | 7 ++ .../atlas-clusters-search-nodes-create.txt | 8 +- .../atlas-clusters-search-nodes-delete.txt | 8 +- .../atlas-clusters-search-nodes-list.txt | 8 +- .../atlas-clusters-search-nodes-update.txt | 8 +- .../command/atlas-clusters-search-nodes.txt | 7 ++ source/command/atlas-clusters-search.txt | 10 +- source/command/atlas-clusters-start.txt | 8 +- source/command/atlas-clusters-update.txt | 8 +- source/command/atlas-clusters-upgrade.txt | 8 +- source/command/atlas-clusters-watch.txt | 8 +- source/command/atlas-clusters.txt | 8 +- source/command/atlas-completion-bash.txt | 3 - source/command/atlas-completion-fish.txt | 5 + .../command/atlas-completion-powershell.txt | 5 + source/command/atlas-completion-zsh.txt | 5 + source/command/atlas-completion.txt | 8 +- source/command/atlas-config-delete.txt | 7 ++ source/command/atlas-config-describe.txt | 10 +- source/command/atlas-config-edit.txt | 8 +- source/command/atlas-config-init.txt | 10 +- source/command/atlas-config-list.txt | 8 +- source/command/atlas-config-rename.txt | 7 ++ source/command/atlas-config-set.txt | 7 ++ source/command/atlas-config.txt | 8 +- source/command/atlas-customDbRoles-create.txt | 8 +- source/command/atlas-customDbRoles-delete.txt | 8 +- .../command/atlas-customDbRoles-describe.txt | 8 +- source/command/atlas-customDbRoles-list.txt | 8 +- source/command/atlas-customDbRoles-update.txt | 8 +- source/command/atlas-customDbRoles.txt | 10 +- .../command/atlas-customDns-aws-describe.txt | 5 + .../command/atlas-customDns-aws-disable.txt | 5 + source/command/atlas-customDns-aws-enable.txt | 5 + source/command/atlas-customDns-aws.txt | 7 ++ source/command/atlas-customDns.txt | 10 +- .../command/atlas-dataFederation-create.txt | 8 +- .../command/atlas-dataFederation-delete.txt | 5 + .../command/atlas-dataFederation-describe.txt | 5 + source/command/atlas-dataFederation-list.txt | 5 + source/command/atlas-dataFederation-logs.txt | 8 +- ...dataFederation-privateEndpoints-create.txt | 5 + ...dataFederation-privateEndpoints-delete.txt | 5 + ...taFederation-privateEndpoints-describe.txt | 5 + ...s-dataFederation-privateEndpoints-list.txt | 5 + .../atlas-dataFederation-privateEndpoints.txt | 10 +- ...tlas-dataFederation-queryLimits-create.txt | 8 +- ...tlas-dataFederation-queryLimits-delete.txt | 8 +- ...as-dataFederation-queryLimits-describe.txt | 8 +- .../atlas-dataFederation-queryLimits-list.txt | 8 +- .../atlas-dataFederation-queryLimits.txt | 10 +- .../command/atlas-dataFederation-update.txt | 5 + source/command/atlas-dataFederation.txt | 10 +- source/command/atlas-dbusers-certs-create.txt | 8 +- source/command/atlas-dbusers-certs-list.txt | 20 +++- source/command/atlas-dbusers-certs.txt | 7 ++ source/command/atlas-dbusers-create.txt | 8 +- source/command/atlas-dbusers-delete.txt | 8 +- source/command/atlas-dbusers-describe.txt | 8 +- source/command/atlas-dbusers-list.txt | 8 +- source/command/atlas-dbusers-update.txt | 8 +- source/command/atlas-dbusers.txt | 8 +- source/command/atlas-deployments-connect.txt | 12 +- source/command/atlas-deployments-delete.txt | 6 + source/command/atlas-deployments-list.txt | 10 +- source/command/atlas-deployments-logs.txt | 10 +- source/command/atlas-deployments-pause.txt | 10 +- ...tlas-deployments-search-indexes-create.txt | 10 +- ...tlas-deployments-search-indexes-delete.txt | 10 +- ...as-deployments-search-indexes-describe.txt | 10 +- .../atlas-deployments-search-indexes-list.txt | 10 +- .../atlas-deployments-search-indexes.txt | 7 ++ source/command/atlas-deployments-search.txt | 7 ++ source/command/atlas-deployments-setup.txt | 10 +- source/command/atlas-deployments-start.txt | 8 +- source/command/atlas-deployments.txt | 10 +- .../atlas-events-organizations-list.txt | 10 +- source/command/atlas-events-organizations.txt | 5 + source/command/atlas-events-projects-list.txt | 10 +- source/command/atlas-events-projects.txt | 5 + source/command/atlas-events.txt | 10 +- ...onSettings-connectedOrgConfigs-connect.txt | 10 +- ...ionSettings-connectedOrgConfigs-delete.txt | 10 +- ...nSettings-connectedOrgConfigs-describe.txt | 10 +- ...ettings-connectedOrgConfigs-disconnect.txt | 10 +- ...ationSettings-connectedOrgConfigs-list.txt | 10 +- ...ionSettings-connectedOrgConfigs-update.txt | 10 +- ...federationSettings-connectedOrgConfigs.txt | 7 ++ ...entication-federationSettings-describe.txt | 8 +- ...nSettings-identityProvider-create-oidc.txt | 7 ++ ...rationSettings-identityProvider-create.txt | 7 ++ ...rationSettings-identityProvider-delete.txt | 5 + ...tionSettings-identityProvider-describe.txt | 5 + ...derationSettings-identityProvider-list.txt | 5 + ...ionSettings-identityProvider-revokeJwk.txt | 5 + ...nSettings-identityProvider-update-oidc.txt | 7 ++ ...rationSettings-identityProvider-update.txt | 7 ++ ...on-federationSettings-identityProvider.txt | 10 +- ...ratedAuthentication-federationSettings.txt | 7 ++ .../command/atlas-federatedAuthentication.txt | 10 +- .../atlas-integrations-create-DATADOG.txt | 5 + .../atlas-integrations-create-OPS_GENIE.txt | 5 + .../atlas-integrations-create-PAGER_DUTY.txt | 5 + .../atlas-integrations-create-VICTOR_OPS.txt | 5 + .../atlas-integrations-create-WEBHOOK.txt | 5 + source/command/atlas-integrations-create.txt | 7 ++ source/command/atlas-integrations-delete.txt | 5 + .../command/atlas-integrations-describe.txt | 5 + source/command/atlas-integrations-list.txt | 5 + source/command/atlas-integrations.txt | 10 +- .../command/atlas-liveMigrations-create.txt | 8 +- .../command/atlas-liveMigrations-cutover.txt | 8 +- .../command/atlas-liveMigrations-describe.txt | 10 +- .../atlas-liveMigrations-link-create.txt | 8 +- .../atlas-liveMigrations-link-delete.txt | 10 +- source/command/atlas-liveMigrations-link.txt | 7 ++ ...atlas-liveMigrations-validation-create.txt | 8 +- ...las-liveMigrations-validation-describe.txt | 10 +- .../atlas-liveMigrations-validation.txt | 7 ++ source/command/atlas-liveMigrations.txt | 10 +- source/command/atlas-logs-download.txt | 8 +- source/command/atlas-logs.txt | 10 +- .../atlas-maintenanceWindows-clear.txt | 5 + .../atlas-maintenanceWindows-defer.txt | 5 + .../atlas-maintenanceWindows-describe.txt | 5 + .../atlas-maintenanceWindows-update.txt | 5 + source/command/atlas-maintenanceWindows.txt | 10 +- .../atlas-metrics-databases-describe.txt | 5 + .../command/atlas-metrics-databases-list.txt | 5 + source/command/atlas-metrics-databases.txt | 7 ++ .../command/atlas-metrics-disks-describe.txt | 5 + source/command/atlas-metrics-disks-list.txt | 5 + source/command/atlas-metrics-disks.txt | 7 ++ source/command/atlas-metrics-processes.txt | 8 +- source/command/atlas-metrics.txt | 10 +- .../atlas-networking-containers-delete.txt | 8 +- .../atlas-networking-containers-list.txt | 8 +- .../command/atlas-networking-containers.txt | 7 ++ .../atlas-networking-peering-create-aws.txt | 8 +- .../atlas-networking-peering-create-azure.txt | 8 +- .../atlas-networking-peering-create-gcp.txt | 8 +- .../atlas-networking-peering-create.txt | 7 ++ .../atlas-networking-peering-delete.txt | 8 +- .../command/atlas-networking-peering-list.txt | 8 +- .../atlas-networking-peering-watch.txt | 8 +- source/command/atlas-networking-peering.txt | 7 ++ source/command/atlas-networking.txt | 10 +- ...ganizations-apiKeys-accessLists-create.txt | 8 +- ...ganizations-apiKeys-accessLists-delete.txt | 8 +- ...organizations-apiKeys-accessLists-list.txt | 8 +- ...tlas-organizations-apiKeys-accessLists.txt | 7 ++ .../atlas-organizations-apiKeys-assign.txt | 5 + .../atlas-organizations-apiKeys-create.txt | 5 + .../atlas-organizations-apiKeys-delete.txt | 5 + .../atlas-organizations-apiKeys-describe.txt | 5 + .../atlas-organizations-apiKeys-list.txt | 8 +- .../command/atlas-organizations-apiKeys.txt | 7 ++ source/command/atlas-organizations-create.txt | 8 +- source/command/atlas-organizations-delete.txt | 5 + .../command/atlas-organizations-describe.txt | 5 + ...atlas-organizations-invitations-delete.txt | 5 + ...las-organizations-invitations-describe.txt | 5 + ...atlas-organizations-invitations-invite.txt | 5 + .../atlas-organizations-invitations-list.txt | 5 + ...atlas-organizations-invitations-update.txt | 5 + .../atlas-organizations-invitations.txt | 5 + source/command/atlas-organizations-list.txt | 5 + .../atlas-organizations-users-list.txt | 5 + source/command/atlas-organizations-users.txt | 7 ++ source/command/atlas-organizations.txt | 8 +- ...las-performanceAdvisor-namespaces-list.txt | 5 + .../atlas-performanceAdvisor-namespaces.txt | 7 ++ ...Advisor-slowOperationThreshold-disable.txt | 5 + ...eAdvisor-slowOperationThreshold-enable.txt | 5 + ...formanceAdvisor-slowOperationThreshold.txt | 7 ++ ...-performanceAdvisor-slowQueryLogs-list.txt | 5 + ...atlas-performanceAdvisor-slowQueryLogs.txt | 10 +- ...rformanceAdvisor-suggestedIndexes-list.txt | 8 +- ...as-performanceAdvisor-suggestedIndexes.txt | 7 ++ source/command/atlas-performanceAdvisor.txt | 10 +- source/command/atlas-plugin-install.txt | 5 + source/command/atlas-plugin-list.txt | 7 ++ source/command/atlas-plugin-uninstall.txt | 5 + source/command/atlas-plugin-update.txt | 5 + source/command/atlas-plugin.txt | 7 ++ .../atlas-privateEndpoints-aws-create.txt | 5 + .../atlas-privateEndpoints-aws-delete.txt | 5 + .../atlas-privateEndpoints-aws-describe.txt | 8 +- ...privateEndpoints-aws-interfaces-create.txt | 5 + ...privateEndpoints-aws-interfaces-delete.txt | 5 + ...ivateEndpoints-aws-interfaces-describe.txt | 5 + .../atlas-privateEndpoints-aws-interfaces.txt | 7 ++ .../atlas-privateEndpoints-aws-list.txt | 5 + .../atlas-privateEndpoints-aws-watch.txt | 5 + source/command/atlas-privateEndpoints-aws.txt | 7 ++ .../atlas-privateEndpoints-azure-create.txt | 5 + .../atlas-privateEndpoints-azure-delete.txt | 5 + .../atlas-privateEndpoints-azure-describe.txt | 5 + ...ivateEndpoints-azure-interfaces-create.txt | 5 + ...ivateEndpoints-azure-interfaces-delete.txt | 5 + ...ateEndpoints-azure-interfaces-describe.txt | 8 +- ...tlas-privateEndpoints-azure-interfaces.txt | 7 ++ .../atlas-privateEndpoints-azure-list.txt | 5 + .../atlas-privateEndpoints-azure-watch.txt | 5 + .../command/atlas-privateEndpoints-azure.txt | 7 ++ .../atlas-privateEndpoints-gcp-create.txt | 5 + .../atlas-privateEndpoints-gcp-delete.txt | 5 + .../atlas-privateEndpoints-gcp-describe.txt | 5 + ...privateEndpoints-gcp-interfaces-create.txt | 5 + ...privateEndpoints-gcp-interfaces-delete.txt | 5 + ...ivateEndpoints-gcp-interfaces-describe.txt | 5 + .../atlas-privateEndpoints-gcp-interfaces.txt | 7 ++ .../atlas-privateEndpoints-gcp-list.txt | 5 + .../atlas-privateEndpoints-gcp-watch.txt | 5 + source/command/atlas-privateEndpoints-gcp.txt | 7 ++ ...rivateEndpoints-regionalModes-describe.txt | 8 +- ...privateEndpoints-regionalModes-disable.txt | 8 +- ...-privateEndpoints-regionalModes-enable.txt | 8 +- .../atlas-privateEndpoints-regionalModes.txt | 7 ++ source/command/atlas-privateEndpoints.txt | 10 +- source/command/atlas-processes-describe.txt | 10 +- source/command/atlas-processes-list.txt | 8 +- source/command/atlas-processes.txt | 10 +- .../command/atlas-projects-apiKeys-assign.txt | 5 + .../command/atlas-projects-apiKeys-create.txt | 5 + .../command/atlas-projects-apiKeys-delete.txt | 8 +- .../command/atlas-projects-apiKeys-list.txt | 8 +- source/command/atlas-projects-apiKeys.txt | 7 ++ source/command/atlas-projects-create.txt | 8 +- source/command/atlas-projects-delete.txt | 5 + source/command/atlas-projects-describe.txt | 5 + source/command/atlas-projects-list.txt | 8 +- .../atlas-projects-settings-describe.txt | 10 +- .../atlas-projects-settings-update.txt | 10 +- source/command/atlas-projects-settings.txt | 5 + source/command/atlas-projects-teams-add.txt | 5 + .../command/atlas-projects-teams-delete.txt | 5 + source/command/atlas-projects-teams-list.txt | 5 + .../command/atlas-projects-teams-update.txt | 5 + source/command/atlas-projects-teams.txt | 7 ++ source/command/atlas-projects-update.txt | 8 +- .../command/atlas-projects-users-delete.txt | 5 + source/command/atlas-projects-users-list.txt | 8 +- source/command/atlas-projects-users.txt | 7 ++ source/command/atlas-projects.txt | 8 +- .../atlas-security-customerCerts-create.txt | 8 +- .../atlas-security-customerCerts-describe.txt | 8 +- .../atlas-security-customerCerts-disable.txt | 8 +- .../command/atlas-security-customerCerts.txt | 7 ++ source/command/atlas-security-ldap-delete.txt | 5 + source/command/atlas-security-ldap-get.txt | 5 + source/command/atlas-security-ldap-save.txt | 5 + ...tlas-security-ldap-verify-status-watch.txt | 5 + .../atlas-security-ldap-verify-status.txt | 5 + source/command/atlas-security-ldap-verify.txt | 5 + source/command/atlas-security-ldap.txt | 7 ++ source/command/atlas-security.txt | 10 +- source/command/atlas-setup.txt | 10 +- .../atlas-streams-connections-create.txt | 5 + .../atlas-streams-connections-delete.txt | 5 + .../atlas-streams-connections-describe.txt | 5 + .../atlas-streams-connections-list.txt | 5 + .../atlas-streams-connections-update.txt | 5 + source/command/atlas-streams-connections.txt | 5 + .../atlas-streams-instances-create.txt | 8 +- .../atlas-streams-instances-delete.txt | 5 + .../atlas-streams-instances-describe.txt | 5 + .../atlas-streams-instances-download.txt | 5 + .../command/atlas-streams-instances-list.txt | 5 + .../atlas-streams-instances-update.txt | 5 + source/command/atlas-streams-instances.txt | 5 + .../atlas-streams-privateLinks-create.txt | 9 ++ .../atlas-streams-privateLinks-delete.txt | 5 + .../atlas-streams-privateLinks-describe.txt | 5 + .../atlas-streams-privateLinks-list.txt | 5 + source/command/atlas-streams-privateLinks.txt | 5 + source/command/atlas-streams.txt | 8 +- source/command/atlas-teams-create.txt | 5 + source/command/atlas-teams-delete.txt | 5 + source/command/atlas-teams-describe.txt | 9 ++ source/command/atlas-teams-list.txt | 8 +- source/command/atlas-teams-rename.txt | 5 + source/command/atlas-teams-users-add.txt | 5 + source/command/atlas-teams-users-delete.txt | 5 + source/command/atlas-teams-users-list.txt | 5 + source/command/atlas-teams-users.txt | 5 + source/command/atlas-teams.txt | 8 +- source/command/atlas-users-describe.txt | 5 + source/command/atlas-users-invite.txt | 8 +- source/command/atlas-users.txt | 8 +- source/command/atlas.txt | 10 +- 913 files changed, 8373 insertions(+), 4611 deletions(-) create mode 100644 source/command/atlas-api-streams-startStreamProcessorWith.txt diff --git a/source/command/atlas-accessLists-create.txt b/source/command/atlas-accessLists-create.txt index 7b147c89..a9bb62b9 100644 --- a/source/command/atlas-accessLists-create.txt +++ b/source/command/atlas-accessLists-create.txt @@ -4,9 +4,6 @@ atlas accessLists create ======================== -.. meta:: - :description: Create an IP access list entry for your project using trusted IPs, AWS security group IDs, or CIDR notation without overwriting existing entries. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas accessLists create Create an IP access list entry for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project. The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries. diff --git a/source/command/atlas-accessLists-delete.txt b/source/command/atlas-accessLists-delete.txt index c0217c72..26a09e1a 100644 --- a/source/command/atlas-accessLists-delete.txt +++ b/source/command/atlas-accessLists-delete.txt @@ -4,9 +4,6 @@ atlas accessLists delete ======================== -.. meta:: - :description: Remove an IP access list entry from your Atlas project using the CLI, with options for confirmation and project specification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas accessLists delete Remove the specified IP access list entry from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command, when run without the force option, prompts you to confirm the operation. To use this command, you must authenticate with a user account or an API key with the Read Write role. diff --git a/source/command/atlas-accessLists-describe.txt b/source/command/atlas-accessLists-describe.txt index 2a661a5c..29160206 100644 --- a/source/command/atlas-accessLists-describe.txt +++ b/source/command/atlas-accessLists-describe.txt @@ -4,9 +4,6 @@ atlas accessLists describe ========================== -.. meta:: - :description: Retrieve details of a specified IP access list entry using the Atlas CLI command with options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas accessLists describe Return the details for the specified IP access list entry. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-accessLists-list.txt b/source/command/atlas-accessLists-list.txt index c9cf6b92..e2c003b9 100644 --- a/source/command/atlas-accessLists-list.txt +++ b/source/command/atlas-accessLists-list.txt @@ -4,9 +4,6 @@ atlas accessLists list ====================== -.. meta:: - :description: List all IP access entries for your project using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas accessLists list Return all IP access list entries for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-accessLists.txt b/source/command/atlas-accessLists.txt index d05c2947..19b36580 100644 --- a/source/command/atlas-accessLists.txt +++ b/source/command/atlas-accessLists.txt @@ -4,9 +4,6 @@ atlas accessLists ================= -.. meta:: - :description: Manage IP access lists for your Atlas project using the CLI, including creating, deleting, and listing entries. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas accessLists Manage the list of IP addresses that can access your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-accessLogs-list.txt b/source/command/atlas-accessLogs-list.txt index c93e3257..eeefb6a3 100644 --- a/source/command/atlas-accessLogs-list.txt +++ b/source/command/atlas-accessLogs-list.txt @@ -14,6 +14,11 @@ atlas accessLogs list Retrieve the access logs of a cluster identified by the cluster's name or hostname. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role. Syntax diff --git a/source/command/atlas-accessLogs.txt b/source/command/atlas-accessLogs.txt index 027746db..4e0a23cf 100644 --- a/source/command/atlas-accessLogs.txt +++ b/source/command/atlas-accessLogs.txt @@ -4,9 +4,6 @@ atlas accessLogs ================ -.. meta:: - :description: Retrieve access logs for a cluster using the Atlas CLI command with optional profile settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas accessLogs Return the access logs for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-alerts-acknowledge.txt b/source/command/atlas-alerts-acknowledge.txt index 31e8236b..f66d0420 100644 --- a/source/command/atlas-alerts-acknowledge.txt +++ b/source/command/atlas-alerts-acknowledge.txt @@ -14,6 +14,11 @@ atlas alerts acknowledge Acknowledges the specified alert for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax @@ -61,6 +66,8 @@ Options - - false - Option that acknowledges an alert 'forever'. You can't set both the forever option and the until option in the same command. + + Mutually exclusive with --until. * - -h, --help - - false @@ -78,6 +85,8 @@ Options - false - ISO 8601-formatted time until which the alert is acknowledged. This command returns this value if a MongoDB user previously acknowledged the alert. After this date, the alert becomes unacknowledged. + Mutually exclusive with --forever. + Inherited Options ----------------- diff --git a/source/command/atlas-alerts-describe.txt b/source/command/atlas-alerts-describe.txt index e67a9406..d95dbd7e 100644 --- a/source/command/atlas-alerts-describe.txt +++ b/source/command/atlas-alerts-describe.txt @@ -14,6 +14,11 @@ atlas alerts describe Return the details for the specified alert for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-alerts-list.txt b/source/command/atlas-alerts-list.txt index 1152d673..774d3faa 100644 --- a/source/command/atlas-alerts-list.txt +++ b/source/command/atlas-alerts-list.txt @@ -14,6 +14,11 @@ atlas alerts list Return all alerts for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-alerts-settings-create.txt b/source/command/atlas-alerts-settings-create.txt index 53d9006e..ab195606 100644 --- a/source/command/atlas-alerts-settings-create.txt +++ b/source/command/atlas-alerts-settings-create.txt @@ -4,9 +4,6 @@ atlas alerts settings create ============================ -.. meta:: - :description: Create an alert configuration for your project using the Atlas CLI with various options for notification and metric settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings create Create an alert configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-alerts-settings-delete.txt b/source/command/atlas-alerts-settings-delete.txt index d777d3ec..d33d5acb 100644 --- a/source/command/atlas-alerts-settings-delete.txt +++ b/source/command/atlas-alerts-settings-delete.txt @@ -4,9 +4,6 @@ atlas alerts settings delete ============================ -.. meta:: - :description: Delete a specified alert configuration in your project using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings delete Remove the specified alert configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-alerts-settings-describe.txt b/source/command/atlas-alerts-settings-describe.txt index d631c063..9125c794 100644 --- a/source/command/atlas-alerts-settings-describe.txt +++ b/source/command/atlas-alerts-settings-describe.txt @@ -4,9 +4,6 @@ atlas alerts settings describe ============================== -.. meta:: - :description: Retrieve details of specific alert settings for your project using the Atlas CLI command with options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings describe Return the details for the specified alert settings for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-alerts-settings-disable.txt b/source/command/atlas-alerts-settings-disable.txt index 63ab63f8..360c0e8f 100644 --- a/source/command/atlas-alerts-settings-disable.txt +++ b/source/command/atlas-alerts-settings-disable.txt @@ -4,9 +4,6 @@ atlas alerts settings disable ============================= -.. meta:: - :description: Disable an alert configuration for a specified project using the Atlas CLI command with options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas alerts settings disable Disables one alert configuration for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-alerts-settings-enable.txt b/source/command/atlas-alerts-settings-enable.txt index 0d05c9bd..81ceb0be 100644 --- a/source/command/atlas-alerts-settings-enable.txt +++ b/source/command/atlas-alerts-settings-enable.txt @@ -4,9 +4,6 @@ atlas alerts settings enable ============================ -.. meta:: - :description: Enable an alert configuration for a specified project using the Atlas CLI command with options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas alerts settings enable Enables one alert configuration for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-alerts-settings-fields-type.txt b/source/command/atlas-alerts-settings-fields-type.txt index f94a23dc..09252b54 100644 --- a/source/command/atlas-alerts-settings-fields-type.txt +++ b/source/command/atlas-alerts-settings-fields-type.txt @@ -4,9 +4,6 @@ atlas alerts settings fields type ================================= -.. meta:: - :description: Retrieve available field types for the matcherFieldName option in alert configurations using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings fields type Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-alerts-settings-fields.txt b/source/command/atlas-alerts-settings-fields.txt index 1f04c66b..2500a9b5 100644 --- a/source/command/atlas-alerts-settings-fields.txt +++ b/source/command/atlas-alerts-settings-fields.txt @@ -14,6 +14,13 @@ atlas alerts settings fields Manages alert configuration fields for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-alerts-settings-list.txt b/source/command/atlas-alerts-settings-list.txt index e764e2bc..6b996a39 100644 --- a/source/command/atlas-alerts-settings-list.txt +++ b/source/command/atlas-alerts-settings-list.txt @@ -4,9 +4,6 @@ atlas alerts settings list ========================== -.. meta:: - :description: Retrieve all alert configurations for your project using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings list Returns all alert configurations for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-alerts-settings-update.txt b/source/command/atlas-alerts-settings-update.txt index 291a466d..6a08acae 100644 --- a/source/command/atlas-alerts-settings-update.txt +++ b/source/command/atlas-alerts-settings-update.txt @@ -4,9 +4,6 @@ atlas alerts settings update ============================ -.. meta:: - :description: Update alert configurations in your project using the Atlas CLI, requiring authentication and offering various options for customization. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings update Modify the details of the specified alert configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-alerts-settings.txt b/source/command/atlas-alerts-settings.txt index 9c2c0f1a..64b230da 100644 --- a/source/command/atlas-alerts-settings.txt +++ b/source/command/atlas-alerts-settings.txt @@ -4,9 +4,6 @@ atlas alerts settings ===================== -.. meta:: - :description: Manage alert configurations for your project by listing, creating, editing, deleting, enabling, and disabling alerts. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas alerts settings Manages alerts configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Use this command to list, create, edit, delete, enable and disable alert configurations. Options diff --git a/source/command/atlas-alerts-unacknowledge.txt b/source/command/atlas-alerts-unacknowledge.txt index 9d66e0b1..6c7aa958 100644 --- a/source/command/atlas-alerts-unacknowledge.txt +++ b/source/command/atlas-alerts-unacknowledge.txt @@ -14,6 +14,11 @@ atlas alerts unacknowledge Unacknowledge the specified alert for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-alerts.txt b/source/command/atlas-alerts.txt index 791c48fa..bdd82ef0 100644 --- a/source/command/atlas-alerts.txt +++ b/source/command/atlas-alerts.txt @@ -4,9 +4,6 @@ atlas alerts ============ -.. meta:: - :description: Manage project alerts using the Atlas CLI with commands to list, acknowledge, describe, and configure alerts. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas alerts Manage alerts for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 14a4da4f..ba8fbe5f 100644 --- a/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -12,9 +12,14 @@ atlas api accessTracking listAccessLogsByClusterName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's name. +`Public Preview: please provide feedback `_: 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 or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName. @@ -75,18 +80,18 @@ Options - int - false - Maximum number of lines from the log to return. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --start - int - false @@ -113,13 +118,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 7f929a0a..85fec226 100644 --- a/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -12,9 +12,14 @@ atlas api accessTracking listAccessLogsByHostname :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's hostname. +`Public Preview: please provide feedback `_: 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 or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname. @@ -75,18 +80,18 @@ Options - int - false - Maximum number of lines from the log to return. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --start - int - false @@ -113,13 +118,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] --pretty false + atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-accessTracking.txt b/source/command/atlas-api-accessTracking.txt index 6f605408..0ebddc34 100644 --- a/source/command/atlas-api-accessTracking.txt +++ b/source/command/atlas-api-accessTracking.txt @@ -12,7 +12,12 @@ atlas api accessTracking :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns access logs for authentication attempts made to Atlas database deployments. +`Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To view database access history, you must have either the Project Owner or Organization Owner role. @@ -51,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's hostname. .. toctree:: diff --git a/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index ff5c02f7..ce4f8469 100644 --- a/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations createAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one alert configuration for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. @@ -62,18 +67,18 @@ Options - - false - help for createAlertConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 79ff4a66..d1812f59 100644 --- a/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations deleteAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one alert configuration from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. This resource remains under revision and may change. @@ -47,7 +52,7 @@ Options * - --alertConfigId - string - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert configuration. * - --envelope - envelope - false @@ -62,18 +67,18 @@ Options - - false - help for deleteAlertConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index dd2f27e9..0bcfc10c 100644 --- a/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations getAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified alert configuration from the specified project. +`Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. This resource remains under revision and may change. @@ -47,7 +52,7 @@ Options * - --alertConfigId - string - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert configuration. * - --envelope - envelope - false @@ -62,18 +67,18 @@ Options - - false - help for getAlertConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 7559fa15..55763db4 100644 --- a/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/source/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +`Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You can successfully call this endpoint with any assigned role. @@ -49,18 +54,18 @@ Options - - false - help for listAlertConfigurationMatchersFieldNames - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -82,14 +87,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api alertConfigurations listAlertConfigurationMatchersFieldNames --version 2023-01-01 --envelope false --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index 4ef5753b..e9ff08b2 100644 --- a/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/source/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations listAlertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alert configurations for one project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. @@ -66,11 +71,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -81,7 +86,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -104,13 +109,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 668d4084..0b401742 100644 --- a/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/source/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alert configurations set for the specified alert. +`Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. This resource remains under revision and may change. @@ -47,7 +52,7 @@ Options * - --alertId - string - true - - Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert. * - --envelope - envelope - false @@ -70,11 +75,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,7 +90,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -108,13 +113,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index 5754a6b8..63e5f1c8 100644 --- a/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations toggleAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the specified alert configuration in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. 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. @@ -50,7 +55,7 @@ Options * - --alertConfigId - string - true - - Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. * - --envelope - envelope - false @@ -69,18 +74,18 @@ Options - - false - help for toggleAlertConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 14daf086..d290cde0 100644 --- a/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/source/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -12,9 +12,14 @@ atlas api alertConfigurations updateAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one alert configuration in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. @@ -50,7 +55,7 @@ Options * - --alertConfigId - string - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert configuration. * - --envelope - envelope - false @@ -69,18 +74,18 @@ Options - - false - help for updateAlertConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alertConfigurations.txt b/source/command/atlas-api-alertConfigurations.txt index b05caf3c..094904ce 100644 --- a/source/command/atlas-api-alertConfigurations.txt +++ b/source/command/atlas-api-alertConfigurations.txt @@ -12,7 +12,12 @@ atlas api alertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +`Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This collection remains under revision and may change. @@ -51,14 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback at `_: Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback at `_: Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback at `_: Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback at `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback at `_: Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback at `_: Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback at `_: Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback at `_: Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback `_: Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback `_: Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback `_: Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback `_: Updates one alert configuration in the specified project. .. toctree:: diff --git a/source/command/atlas-api-alerts-acknowledgeAlert.txt b/source/command/atlas-api-alerts-acknowledgeAlert.txt index 5bff53f0..4bee2778 100644 --- a/source/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/source/command/atlas-api-alerts-acknowledgeAlert.txt @@ -12,9 +12,14 @@ atlas api alerts acknowledgeAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Confirms receipt of one existing alert. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. This resource remains under revision and may change. @@ -47,7 +52,7 @@ Options * - --alertId - string - true - - Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert. * - --envelope - envelope - false @@ -66,18 +71,18 @@ Options - - false - help for acknowledgeAlert - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-alerts-getAlert.txt b/source/command/atlas-api-alerts-getAlert.txt index be229e75..ac0bf3d4 100644 --- a/source/command/atlas-api-alerts-getAlert.txt +++ b/source/command/atlas-api-alerts-getAlert.txt @@ -12,9 +12,14 @@ atlas api alerts getAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one alert. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. This resource remains under revision and may change. @@ -47,7 +52,7 @@ Options * - --alertId - string - true - - Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert. * - --envelope - envelope - false @@ -62,18 +67,18 @@ Options - - false - help for getAlert - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alerts getAlert --version 2023-01-01 --alertId [alertId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api alerts getAlert --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alerts-listAlerts.txt b/source/command/atlas-api-alerts-listAlerts.txt index 1eb42d16..deb7de30 100644 --- a/source/command/atlas-api-alerts-listAlerts.txt +++ b/source/command/atlas-api-alerts-listAlerts.txt @@ -12,9 +12,14 @@ atlas api alerts listAlerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alerts. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. @@ -66,11 +71,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -81,7 +86,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --status - string - false @@ -108,13 +113,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alerts listAlerts --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api alerts listAlerts --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 5a2ffdf1..cca9aa4f 100644 --- a/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/source/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -12,9 +12,14 @@ atlas api alerts listAlertsByAlertConfigurationId :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. This resource remains under revision and may change. @@ -47,7 +52,7 @@ Options * - --alertConfigId - string - true - - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the alert configuration. * - --envelope - envelope - false @@ -70,11 +75,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,7 +90,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -108,13 +113,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api alerts listAlertsByAlertConfigurationId --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api alerts listAlertsByAlertConfigurationId --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-alerts.txt b/source/command/atlas-api-alerts.txt index 717f4073..ac8b7cc1 100644 --- a/source/command/atlas-api-alerts.txt +++ b/source/command/atlas-api-alerts.txt @@ -12,7 +12,12 @@ atlas api alerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +`Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This collection remains under revision and may change. @@ -51,10 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback at `_: Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback at `_: Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback at `_: Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback `_: Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback `_: Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback `_: Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers. .. toctree:: diff --git a/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 858fb2e2..be212d4f 100644 --- a/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch createAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment. @@ -61,18 +66,18 @@ Options - - false - help for createAtlasSearchDeployment - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 9e9ad70b..fb7b9477 100644 --- a/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -12,9 +12,14 @@ atlas api atlasSearch createAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex. @@ -63,18 +68,18 @@ Options - - false - help for createAtlasSearchIndex - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index 84f9f1b6..4f20178e 100644 --- a/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -12,9 +12,14 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated. @@ -63,18 +68,18 @@ Options - - false - help for createAtlasSearchIndexDeprecated - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 053fedce..ed6205f9 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch deleteAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment. @@ -57,18 +62,18 @@ Options - - false - help for deleteAtlasSearchDeployment - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch deleteAtlasSearchDeployment --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch deleteAtlasSearchDeployment --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index 812c236c..f70bf8d6 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -12,9 +12,14 @@ atlas api atlasSearch deleteAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch deleteAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch deleteAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index e5ea0998..fee20ac6 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -12,9 +12,14 @@ atlas api atlasSearch deleteAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName. @@ -71,18 +76,18 @@ Options - string - true - Name of the Atlas Search index to delete. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch deleteAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] --pretty false + atlas api atlasSearch deleteAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 7997c2b1..6b1254eb 100644 --- a/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -12,9 +12,14 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch deleteAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch deleteAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index a1957962..6525be78 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment. @@ -57,18 +62,18 @@ Options - - false - help for getAtlasSearchDeployment - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch getAtlasSearchDeployment --version 2025-03-12 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch getAtlasSearchDeployment --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index cbaf4cae..721ec27b 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch getAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch getAtlasSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index 1f2b40f9..912b8381 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -12,7 +12,12 @@ atlas api atlasSearch getAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. +`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -71,18 +76,18 @@ Options - string - true - Name of the Atlas Search index to return. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch getAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] --pretty false + atlas api atlasSearch getAtlasSearchIndexByName --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --indexName [indexName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index f67219b2..a13af36f 100644 --- a/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -12,9 +12,14 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch getAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] --pretty false + atlas api atlasSearch getAtlasSearchIndexDeprecated --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 3e0477dc..0ce7091a 100644 --- a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -12,9 +12,14 @@ atlas api atlasSearch listAtlasSearchIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes. @@ -67,18 +72,18 @@ Options - - false - help for listAtlasSearchIndexes - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch listAtlasSearchIndexes --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch listAtlasSearchIndexes --version 2024-05-30 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index fe013e89..f40f10ae 100644 --- a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -12,9 +12,14 @@ atlas api atlasSearch listAtlasSearchIndexesCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster. @@ -59,18 +64,18 @@ Options - - false - help for listAtlasSearchIndexesCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch listAtlasSearchIndexesCluster --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch listAtlasSearchIndexesCluster --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 0795481f..6ab40e44 100644 --- a/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -12,9 +12,14 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated. @@ -67,18 +72,18 @@ Options - - false - help for listAtlasSearchIndexesDeprecated - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api atlasSearch listAtlasSearchIndexesDeprecated --version 2023-01-01 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api atlasSearch listAtlasSearchIndexesDeprecated --version 2023-01-01 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 724eb6b5..7f87829b 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -12,7 +12,12 @@ atlas api atlasSearch updateAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment. @@ -61,18 +66,18 @@ Options - - false - help for updateAtlasSearchDeployment - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index 9d3681b7..836c5b44 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -12,9 +12,14 @@ atlas api atlasSearch updateAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex. @@ -67,18 +72,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 8561f60c..c3bccba1 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -12,9 +12,14 @@ atlas api atlasSearch updateAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName. @@ -75,18 +80,18 @@ Options - string - true - Name of the Atlas Search index to update. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index e7fa38ab..84b342c7 100644 --- a/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/source/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -12,9 +12,14 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated. @@ -67,18 +72,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-atlasSearch.txt b/source/command/atlas-api-atlasSearch.txt index c550c6ad..8ce85965 100644 --- a/source/command/atlas-api-atlasSearch.txt +++ b/source/command/atlas-api-atlasSearch.txt @@ -12,7 +12,12 @@ atlas api atlasSearch :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Also returns and updates user-defined analyzers for the specified cluster. @@ -51,24 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Returns the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. .. toctree:: diff --git a/source/command/atlas-api-auditing-getAuditingConfiguration.txt b/source/command/atlas-api-auditing-getAuditingConfiguration.txt index 2e6e28dd..3f43c39e 100644 --- a/source/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/source/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -12,9 +12,14 @@ atlas api auditing getAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration. @@ -55,18 +60,18 @@ Options - - false - help for getAuditingConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api auditing getAuditingConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api auditing getAuditingConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-auditing-updateAuditingConfiguration.txt b/source/command/atlas-api-auditing-updateAuditingConfiguration.txt index fef89b00..a8a8c01d 100644 --- a/source/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/source/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -12,9 +12,14 @@ atlas api auditing updateAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration. @@ -59,18 +64,18 @@ Options - - false - help for updateAuditingConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-auditing.txt b/source/command/atlas-api-auditing.txt index b8f6b066..26b4564a 100644 --- a/source/command/atlas-api-auditing.txt +++ b/source/command/atlas-api-auditing.txt @@ -12,7 +12,14 @@ atlas api auditing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits database auditing settings for MongoDB Cloud projects. +`Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project. .. toctree:: diff --git a/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index c06b7298..926f2f45 100644 --- a/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/source/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -12,9 +12,14 @@ atlas api awsClustersDns getAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns. @@ -55,18 +60,18 @@ Options - - false - help for getAwsCustomDns - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api awsClustersDns getAwsCustomDns --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api awsClustersDns getAwsCustomDns --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 4ba68ac2..d7ed862d 100644 --- a/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/source/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -12,9 +12,14 @@ atlas api awsClustersDns toggleAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns. @@ -59,18 +64,18 @@ Options - - false - help for toggleAwsCustomDns - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-awsClustersDns.txt b/source/command/atlas-api-awsClustersDns.txt index 3542354c..9dfe02b1 100644 --- a/source/command/atlas-api-awsClustersDns.txt +++ b/source/command/atlas-api-awsClustersDns.txt @@ -12,7 +12,12 @@ atlas api awsClustersDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +`Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `Public Preview: please provide feedback `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. .. toctree:: diff --git a/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 85674632..9d1c95af 100644 --- a/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api cloudBackups cancelBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. +`Public Preview: please provide feedback `_: 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 Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob. @@ -59,18 +64,18 @@ Options - - false - help for cancelBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --restoreJobId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups cancelBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreJobId [restoreJobId] + atlas api cloudBackups cancelBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-createBackupExportJob.txt b/source/command/atlas-api-cloudBackups-createBackupExportJob.txt index 7f25304c..1c20672e 100644 --- a/source/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/source/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -12,9 +12,14 @@ atlas api cloudBackups createBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob. @@ -63,11 +68,11 @@ Options - - false - help for createBackupExportJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 44576b6a..b621bb9a 100644 --- a/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -12,12 +12,17 @@ atlas api cloudBackups createBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one cluster from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob. @@ -66,18 +71,18 @@ Options - - false - help for createBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-createExportBucket.txt b/source/command/atlas-api-cloudBackups-createExportBucket.txt index 325bc356..7bfb27a6 100644 --- a/source/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/source/command/atlas-api-cloudBackups-createExportBucket.txt @@ -12,9 +12,14 @@ atlas api cloudBackups createExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +`Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. -Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket. @@ -59,18 +64,18 @@ Options - - false - help for createExportBucket - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,18 +98,18 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2023-01-01_aws - AWS - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # AWS { "bucketName": "export-bucket", "cloudProvider": "AWS", @@ -113,23 +118,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api cloudBackups createExportBucket --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # AWS + atlas api cloudBackups createExportBucket --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2024-05-30_aws - AWS - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # AWS { "bucketName": "export-bucket", "cloudProvider": "AWS", @@ -138,24 +143,25 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # AWS + atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 2 :tabid: 2024-05-30_azure - Azure - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Azure { + "bucketName": "examplecontainer", "cloudProvider": "AZURE", "roleId": "668c5f0ed436263134491592", "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" @@ -163,11 +169,37 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. + + .. code-block:: + + # Azure + atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 + + .. Code end marker, please don't delete this comment + + .. tab:: Example 3 + :tabid: 2024-05-30_gcp + + Create the file below and save it as ``payload.json`` + + .. code-block:: + + # GCP + { + "bucketName": "export-bucket", + "cloudProvider": "GCP", + "roleId": "668c5f0ed436263134491592" + } + + .. Code end marker, please don't delete this comment + + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # GCP + atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 8dcab107..ed02cafb 100644 --- a/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api cloudBackups createServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the createFlexBackupRestoreJob endpoint instead. @@ -66,18 +71,18 @@ Options - - false - help for createServerlessBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 79ab8891..a54441c6 100644 --- a/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/source/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -12,9 +12,14 @@ atlas api cloudBackups deleteAllBackupSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules. @@ -59,11 +64,11 @@ Options - - false - help for deleteAllBackupSchedules - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups deleteAllBackupSchedules --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups deleteAllBackupSchedules --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-deleteExportBucket.txt b/source/command/atlas-api-cloudBackups-deleteExportBucket.txt index 54dd6841..65e7e0d9 100644 --- a/source/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/source/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -12,9 +12,14 @@ atlas api cloudBackups deleteExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes an Export Bucket. +`Public Preview: please provide feedback `_: 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 Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket. @@ -59,11 +64,11 @@ Options - - false - help for deleteExportBucket - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups deleteExportBucket --version 2023-01-01 --envelope false --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups deleteExportBucket --version 2023-01-01 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 03e2f93d..256ea219 100644 --- a/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/source/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -12,9 +12,14 @@ atlas api cloudBackups deleteReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified snapshot. +`Public Preview: please provide feedback `_: Removes the specified snapshot. -To use this resource, the requesting API Key must have the Project Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup. @@ -59,18 +64,18 @@ Options - - false - help for deleteReplicaSetBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups deleteReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups deleteReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 1d5ec35f..8b316e82 100644 --- a/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/source/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -12,9 +12,14 @@ atlas api cloudBackups deleteShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. -To use this resource, the requesting API Key must have the Project Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup. @@ -59,18 +64,18 @@ Options - - false - help for deleteShardedClusterBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups deleteShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups deleteShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index cf67da0f..72ff027b 100644 --- a/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/source/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -12,9 +12,14 @@ atlas api cloudBackups disableDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings. @@ -55,18 +60,18 @@ Options - - false - help for disableDataProtectionSettings - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups disableDataProtectionSettings --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups disableDataProtectionSettings --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getBackupExportJob.txt b/source/command/atlas-api-cloudBackups-getBackupExportJob.txt index a8e303b2..bb7c509d 100644 --- a/source/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/source/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob. @@ -63,11 +68,11 @@ Options - - false - help for getBackupExportJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getBackupExportJob --version 2023-01-01 --clusterName [clusterName] --envelope false --exportId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups getBackupExportJob --version 2023-01-01 --clusterName [clusterName] --exportId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index b0c70861..a3ade02a 100644 --- a/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. +`Public Preview: please provide feedback `_: 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 Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob. @@ -59,18 +64,18 @@ Options - - false - help for getBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --restoreJobId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreJobId [restoreJobId] + atlas api cloudBackups getBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getBackupSchedule.txt b/source/command/atlas-api-cloudBackups-getBackupSchedule.txt index 19d3ac75..8be902e9 100644 --- a/source/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/source/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule. @@ -59,18 +64,18 @@ Options - - false - help for getBackupSchedule - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getBackupSchedule --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups getBackupSchedule --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index cc5f7d06..6f1d82e3 100644 --- a/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/source/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. +`Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings. @@ -55,18 +60,18 @@ Options - - false - help for getDataProtectionSettings - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getDataProtectionSettings --version 2023-10-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups getDataProtectionSettings --version 2023-10-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getExportBucket.txt b/source/command/atlas-api-cloudBackups-getExportBucket.txt index 9189b7ce..9fd2c30d 100644 --- a/source/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/source/command/atlas-api-cloudBackups-getExportBucket.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Export Bucket associated with the specified Project. +`Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket. @@ -59,11 +64,11 @@ Options - - false - help for getExportBucket - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getExportBucket --version 2024-05-30 --envelope false --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups getExportBucket --version 2024-05-30 --exportBucketId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index 81ac9377..caa17ebd 100644 --- a/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/source/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. +`Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. -To use this resource, the requesting API Key must have the Project Read Only role or Project Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup. @@ -59,18 +64,18 @@ Options - - false - help for getReplicaSetBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups getReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getServerlessBackup.txt b/source/command/atlas-api-cloudBackups-getServerlessBackup.txt index 0380b83b..48bb89d7 100644 --- a/source/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/source/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getServerlessBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created with the createServerlessInstance API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackup endpoint instead. @@ -62,11 +67,11 @@ Options - - false - help for getServerlessBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getServerlessBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --snapshotId 32b6e34b3d91647abb20e7b8 + atlas api cloudBackups getServerlessBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 9e252bb0..5a5d017b 100644 --- a/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/source/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the getFlexBackupRestoreJob endpoint instead. @@ -62,18 +67,18 @@ Options - - false - help for getServerlessBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --restoreJobId - string - true @@ -100,13 +105,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getServerlessBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreJobId [restoreJobId] + atlas api cloudBackups getServerlessBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index a9b1eb53..a8ed172b 100644 --- a/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/source/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -12,9 +12,14 @@ atlas api cloudBackups getShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: 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 or Project Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup. @@ -59,18 +64,18 @@ Options - - false - help for getShardedClusterBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups getShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api cloudBackups getShardedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 7d4ffeee..138b9f17 100644 --- a/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/source/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listBackupExportJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listBackupExportJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listBackupExportJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 8d4008f8..f09b3c38 100644 --- a/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/source/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. +`Public Preview: please provide feedback `_: 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 Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listExportBuckets.txt b/source/command/atlas-api-cloudBackups-listExportBuckets.txt index 271be817..d79b8f62 100644 --- a/source/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/source/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listExportBuckets :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Export Buckets associated with the specified Project. +`Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listExportBuckets --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listExportBuckets --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index 8a3d4f19..5a1b8f4e 100644 --- a/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/source/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listReplicaSetBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. +`Public Preview: please provide feedback `_: 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 or Project Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listReplicaSetBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listReplicaSetBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 77298596..75ca5e0d 100644 --- a/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/source/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listServerlessBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead. @@ -70,11 +75,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,7 +90,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -108,13 +113,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listServerlessBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listServerlessBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listServerlessBackups.txt b/source/command/atlas-api-cloudBackups-listServerlessBackups.txt index ee748a3f..3ac3dcc3 100644 --- a/source/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/source/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listServerlessBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackups endpoint instead. @@ -70,11 +75,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,7 +90,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -108,13 +113,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listServerlessBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api cloudBackups listServerlessBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 3c19e763..82818e20 100644 --- a/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/source/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -12,9 +12,14 @@ atlas api cloudBackups listShardedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: 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 or Project Backup Manager role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups. @@ -59,18 +64,18 @@ Options - - false - help for listShardedClusterBackups - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudBackups listShardedClusterBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudBackups listShardedClusterBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudBackups-takeSnapshot.txt b/source/command/atlas-api-cloudBackups-takeSnapshot.txt index 2d68c2ab..7d6f14f2 100644 --- a/source/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/source/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -12,12 +12,17 @@ atlas api cloudBackups takeSnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Takes one on-demand snapshot for the specified cluster. +`Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 Backup Manager role. +To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot. @@ -66,18 +71,18 @@ Options - - false - help for takeSnapshot - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt index 3eca52fb..cfb47f95 100644 --- a/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/source/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -12,9 +12,14 @@ atlas api cloudBackups updateBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule. @@ -63,18 +68,18 @@ Options - - false - help for updateBackupSchedule - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 266d006a..c52b7613 100644 --- a/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/source/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -12,9 +12,14 @@ atlas api cloudBackups updateDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. +`Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings. @@ -59,11 +64,11 @@ Options - - false - help for updateDataProtectionSettings - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -74,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 5cabb90e..a9c84132 100644 --- a/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/source/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -12,7 +12,12 @@ atlas api cloudBackups updateSnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The requesting API Key must have the Project Backup Manager role. @@ -63,18 +68,18 @@ Options - - false - help for updateSnapshotRetention - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true diff --git a/source/command/atlas-api-cloudBackups.txt b/source/command/atlas-api-cloudBackups.txt index 17e72c5d..0af954f8 100644 --- a/source/command/atlas-api-cloudBackups.txt +++ b/source/command/atlas-api-cloudBackups.txt @@ -12,7 +12,12 @@ atlas api cloudBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +`Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource applies only to clusters that use Cloud Backups. @@ -51,36 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `Public Preview: please provide feedback at `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback at `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback at `_: Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback at `_: Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - `Public Preview: please provide feedback at `_: Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - `Public Preview: please provide feedback at `_: Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - `Public Preview: please provide feedback at `_: Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `Public Preview: please provide feedback at `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `Public Preview: please provide feedback `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback `_: Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback `_: Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `Public Preview: please provide feedback `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `Public Preview: please provide feedback `_: Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - `Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `Public Preview: please provide feedback `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - `Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - `Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `Public Preview: please provide feedback `_: Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. .. toctree:: diff --git a/source/command/atlas-api-cloudMigrationService-createLinkToken.txt b/source/command/atlas-api-cloudMigrationService-createLinkToken.txt index f9d116a8..1d4e6107 100644 --- a/source/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/source/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService createLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one link-token that contains all the information required to complete the link. +`Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudMigrationService-createPushMigration.txt b/source/command/atlas-api-cloudMigrationService-createPushMigration.txt index 07d0dcf8..0e7c37e2 100644 --- a/source/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService createPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +`Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Please make sure to validate your migration before initiating it. @@ -65,18 +70,18 @@ Options - - false - help for createPushMigration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt index de7342ed..d5abf7ae 100644 --- a/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService cutoverMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cut over the migrated cluster to MongoDB Atlas. +`Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -59,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the migration. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudMigrationService cutoverMigration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 --pretty false + atlas api cloudMigrationService cutoverMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index 61690d44..ceac87ed 100644 --- a/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/source/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService deleteLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Remove one organization link and its associated public API key. +`Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -53,11 +58,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -83,13 +88,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudMigrationService deleteLinkToken --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 + atlas api cloudMigrationService deleteLinkToken --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-getPushMigration.txt b/source/command/atlas-api-cloudMigrationService-getPushMigration.txt index cefa8a15..29184178 100644 --- a/source/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService getPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return details of one cluster migration job. +`Public Preview: please provide feedback `_: Return details of one cluster migration job. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. @@ -59,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the migration. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudMigrationService getPushMigration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 --pretty false + atlas api cloudMigrationService getPushMigration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --liveMigrationId 6296fb4c7c7aa997cf94e9a8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 277e5bbd..75457b7a 100644 --- a/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/source/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService getValidationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the status of one migration validation job. +`Public Preview: please provide feedback `_: Return the status of one migration validation job. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Your API Key must have the Organization Owner role to successfully call this resource. @@ -55,11 +60,11 @@ Options - - false - help for getValidationStatus - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudMigrationService getValidationStatus --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --validationId 507f1f77bcf86cd799439011 + atlas api cloudMigrationService getValidationStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --validationId 507f1f77bcf86cd799439011 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 78d80dd6..f69c4d97 100644 --- a/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/source/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService listSourceProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all projects that you can migrate to the specified organization. +`Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects. @@ -51,18 +56,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudMigrationService listSourceProjects --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api cloudMigrationService listSourceProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudMigrationService-validateMigration.txt b/source/command/atlas-api-cloudMigrationService-validateMigration.txt index 64e4dadf..a63fe9f1 100644 --- a/source/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/source/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService validateMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +`Public Preview: please provide feedback `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. @@ -59,18 +64,18 @@ Options - - false - help for validateMigration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudMigrationService.txt b/source/command/atlas-api-cloudMigrationService.txt index b914deb8..26af5500 100644 --- a/source/command/atlas-api-cloudMigrationService.txt +++ b/source/command/atlas-api-cloudMigrationService.txt @@ -12,7 +12,12 @@ atlas api cloudMigrationService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages the Cloud Migration Service. +`Public Preview: please provide feedback `_: Manages the Cloud Migration Service. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `Public Preview: please provide feedback at `_: Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `Public Preview: please provide feedback at `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `Public Preview: please provide feedback at `_: Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `Public Preview: please provide feedback at `_: Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `Public Preview: please provide feedback at `_: Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `Public Preview: please provide feedback at `_: Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `Public Preview: please provide feedback at `_: Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - `Public Preview: please provide feedback at `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `Public Preview: please provide feedback `_: Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `Public Preview: please provide feedback `_: Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - `Public Preview: please provide feedback `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. .. toctree:: diff --git a/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index 17e0f4fc..e0d268d6 100644 --- a/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -12,9 +12,14 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole. @@ -59,18 +64,18 @@ Options - - false - help for authorizeCloudProviderAccessRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --roleId - string - true diff --git a/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index f2ff4188..996948a0 100644 --- a/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -12,9 +12,14 @@ atlas api cloudProviderAccess createCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole. @@ -59,18 +64,18 @@ Options - - false - help for createCloudProviderAccessRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index db8a0f33..7b8442c2 100644 --- a/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -12,9 +12,14 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole. @@ -59,18 +64,18 @@ Options - - false - help for deauthorizeCloudProviderAccessRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --roleId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole --version 2023-01-01 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleId [roleId] + atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --roleId [roleId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index e47baf2c..a051c44f 100644 --- a/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/source/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -12,9 +12,14 @@ atlas api cloudProviderAccess getCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access role with the specified id and with access to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole. @@ -55,18 +60,18 @@ Options - - false - help for getCloudProviderAccessRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --roleId - string - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudProviderAccess getCloudProviderAccessRole --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleId [roleId] + atlas api cloudProviderAccess getCloudProviderAccessRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleId [roleId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index c688b529..904e9da4 100644 --- a/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/source/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -12,9 +12,14 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all cloud provider access roles with access to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles. @@ -55,18 +60,18 @@ Options - - false - help for listCloudProviderAccessRoles - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api cloudProviderAccess listCloudProviderAccessRoles --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api cloudProviderAccess listCloudProviderAccessRoles --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-cloudProviderAccess.txt b/source/command/atlas-api-cloudProviderAccess.txt index 36a7aa91..6454c844 100644 --- a/source/command/atlas-api-cloudProviderAccess.txt +++ b/source/command/atlas-api-cloudProviderAccess.txt @@ -12,7 +12,14 @@ atlas api cloudProviderAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +`Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `Public Preview: please provide feedback at `_: Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `Public Preview: please provide feedback `_: Returns all cloud provider access roles with access to the specified project. .. toctree:: diff --git a/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index d3e6d18b..501cb61e 100644 --- a/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -12,7 +12,12 @@ atlas api clusterOutageSimulation endOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Ends a cluster outage simulation. +`Public Preview: please provide feedback `_: Ends a cluster outage simulation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation. @@ -57,18 +62,18 @@ Options - - false - help for endOutageSimulation - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusterOutageSimulation endOutageSimulation --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusterOutageSimulation endOutageSimulation --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index 4be16a03..d7603fc2 100644 --- a/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -12,7 +12,12 @@ atlas api clusterOutageSimulation getOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one outage simulation for one cluster. +`Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation. @@ -57,18 +62,18 @@ Options - - false - help for getOutageSimulation - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusterOutageSimulation getOutageSimulation --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusterOutageSimulation getOutageSimulation --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index dce25ff7..63e8d907 100644 --- a/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -12,7 +12,12 @@ atlas api clusterOutageSimulation startOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Starts a cluster outage simulation. +`Public Preview: please provide feedback `_: Starts a cluster outage simulation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation. @@ -61,18 +66,18 @@ Options - - false - help for startOutageSimulation - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusterOutageSimulation.txt b/source/command/atlas-api-clusterOutageSimulation.txt index 2e11513c..c189351a 100644 --- a/source/command/atlas-api-clusterOutageSimulation.txt +++ b/source/command/atlas-api-clusterOutageSimulation.txt @@ -12,7 +12,14 @@ atlas api clusterOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, starts, or ends a cluster outage simulation. +`Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback at `_: Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback at `_: Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback at `_: Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback `_: Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback `_: Starts a cluster outage simulation. .. toctree:: diff --git a/source/command/atlas-api-clusters-autoScalingConfiguration.txt b/source/command/atlas-api-clusters-autoScalingConfiguration.txt index bbca117f..d4db0fce 100644 --- a/source/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/source/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -12,7 +12,12 @@ atlas api clusters autoScalingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the internal configuration of AutoScaling for sharded clusters. +`Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. @@ -59,18 +64,18 @@ Options - - false - help for autoScalingConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters autoScalingConfiguration --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters autoScalingConfiguration --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-createCluster.txt b/source/command/atlas-api-clusters-createCluster.txt index c605cde8..113702e8 100644 --- a/source/command/atlas-api-clusters-createCluster.txt +++ b/source/command/atlas-api-clusters-createCluster.txt @@ -12,9 +12,14 @@ atlas api clusters createCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward. @@ -62,18 +67,18 @@ Options - - false - help for createCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -104,18 +109,18 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2024-08-05_cluster - Cluster - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Cluster { "clusterType": "SHARDED", "name": "myCluster", @@ -219,23 +224,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters createCluster --version 2024-08-05 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Cluster + atlas api clusters createCluster --version 2024-08-05 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2024-10-23_cluster - Cluster - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Cluster { "clusterType": "SHARDED", "name": "myCluster", @@ -351,23 +356,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters createCluster --version 2024-10-23 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Cluster + atlas api clusters createCluster --version 2024-10-23 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Create a basic MongoDB Atlas cluster :tabid: 2024-10-23_create_cluster - Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 { "clusterType": "REPLICASET", "name": "MyCluster", @@ -391,11 +396,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters createCluster --version 2024-10-23 --file payload.json --envelope false --groupId [your-project-id] --pretty false + # Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 + atlas api clusters createCluster --version 2024-10-23 --file payload.json --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-deleteCluster.txt b/source/command/atlas-api-clusters-deleteCluster.txt index cd12d142..3aa744f3 100644 --- a/source/command/atlas-api-clusters-deleteCluster.txt +++ b/source/command/atlas-api-clusters-deleteCluster.txt @@ -12,9 +12,14 @@ atlas api clusters deleteCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. @@ -62,18 +67,18 @@ Options - - false - help for deleteCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --retainBackups - - false @@ -108,15 +113,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Deletes the specified cluster from the project - -Run the command below. +-------- .. code-block:: - atlas api clusters deleteCluster --version 2023-02-01 --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false + # Deletes the specified cluster from the project + atlas api clusters deleteCluster --version 2023-02-01 --clusterName [your-cluster-name] --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getCluster.txt b/source/command/atlas-api-clusters-getCluster.txt index 33204d27..58961961 100644 --- a/source/command/atlas-api-clusters-getCluster.txt +++ b/source/command/atlas-api-clusters-getCluster.txt @@ -12,9 +12,14 @@ atlas api clusters getCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the getFlexCluster endpoint for Flex clusters instead. @@ -62,18 +67,18 @@ Options - - false - help for getCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,15 +101,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns the details for the specified cluster in the project - -Run the command below. +-------- .. code-block:: - atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false + # Returns the details for the specified cluster in the project + atlas api clusters getCluster --version 2024-08-05 --clusterName [your-cluster-name] --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 507a1548..fced8f15 100644 --- a/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/source/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -12,9 +12,14 @@ atlas api clusters getClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration. @@ -59,18 +64,18 @@ Options - - false - help for getClusterAdvancedConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters getClusterAdvancedConfiguration --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters getClusterAdvancedConfiguration --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getClusterStatus.txt b/source/command/atlas-api-clusters-getClusterStatus.txt index c87a6b15..f6c7880b 100644 --- a/source/command/atlas-api-clusters-getClusterStatus.txt +++ b/source/command/atlas-api-clusters-getClusterStatus.txt @@ -12,9 +12,14 @@ atlas api clusters getClusterStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of all changes that you made to the specified cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus. @@ -59,18 +64,18 @@ Options - - false - help for getClusterStatus - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters getClusterStatus --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters getClusterStatus --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 9b0b9f60..ba2b5110 100644 --- a/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/source/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -12,9 +12,14 @@ atlas api clusters getSampleDatasetLoadStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Checks the progress of loading the sample dataset into one cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus. @@ -55,11 +60,11 @@ Options - - false - help for getSampleDatasetLoadStatus - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters getSampleDatasetLoadStatus --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --sampleDatasetId [sampleDatasetId] + atlas api clusters getSampleDatasetLoadStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --sampleDatasetId [sampleDatasetId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index e170c3b0..272e1697 100644 --- a/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/source/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -12,7 +12,12 @@ atlas api clusters grantMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +`Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess. @@ -61,18 +66,18 @@ Options - - false - help for grantMongoDbEmployeeAccess - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-listCloudProviderRegions.txt b/source/command/atlas-api-clusters-listCloudProviderRegions.txt index 943f5fed..02ef17e1 100644 --- a/source/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/source/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -12,9 +12,14 @@ atlas api clusters listCloudProviderRegions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of regions available for the specified cloud provider at the specified tier. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --providers - stringArray - false @@ -109,13 +114,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters listCloudProviderRegions --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api clusters listCloudProviderRegions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-listClusters.txt b/source/command/atlas-api-clusters-listClusters.txt index 4d3cfa58..a61f2ef3 100644 --- a/source/command/atlas-api-clusters-listClusters.txt +++ b/source/command/atlas-api-clusters-listClusters.txt @@ -12,9 +12,14 @@ atlas api clusters listClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for all clusters in the specific project to which you have access. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the listFlexClusters endpoint for Flex clusters instead. @@ -70,11 +75,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,7 +90,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -108,15 +113,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns all clusters in the specified project - -Run the command below. +-------- .. code-block:: - atlas api clusters listClusters --version 2024-08-05 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Returns all clusters in the specified project + atlas api clusters listClusters --version 2024-08-05 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-listClustersForAllProjects.txt b/source/command/atlas-api-clusters-listClustersForAllProjects.txt index b4c9c967..5be6346b 100644 --- a/source/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/source/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -12,9 +12,14 @@ atlas api clusters listClustersForAllProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for all clusters in all projects to which you have access. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects. @@ -57,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -94,14 +99,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api clusters listClustersForAllProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-clusters-loadSampleDataset.txt b/source/command/atlas-api-clusters-loadSampleDataset.txt index a450cc39..684cf0fe 100644 --- a/source/command/atlas-api-clusters-loadSampleDataset.txt +++ b/source/command/atlas-api-clusters-loadSampleDataset.txt @@ -12,9 +12,14 @@ atlas api clusters loadSampleDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. +`Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset. @@ -59,11 +64,11 @@ Options - string - true - Human-readable label that identifies the cluster into which you load the sample dataset. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters loadSampleDataset --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] + atlas api clusters loadSampleDataset --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index cf7dd609..df030e9d 100644 --- a/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/source/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -12,7 +12,12 @@ atlas api clusters pinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +`Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -63,18 +68,18 @@ Options - - false - help for pinFeatureCompatibilityVersion - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 3866a55c..80d1b4b7 100644 --- a/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/source/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -12,7 +12,12 @@ atlas api clusters revokeMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes a previously granted MongoDB employee cluster access. +`Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess. @@ -57,18 +62,18 @@ Options - - false - help for revokeMongoDbEmployeeAccess - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters revokeMongoDbEmployeeAccess --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters revokeMongoDbEmployeeAccess --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-testFailover.txt b/source/command/atlas-api-clusters-testFailover.txt index 5e0743a6..671033d5 100644 --- a/source/command/atlas-api-clusters-testFailover.txt +++ b/source/command/atlas-api-clusters-testFailover.txt @@ -12,9 +12,14 @@ atlas api clusters testFailover :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover. @@ -59,18 +64,18 @@ Options - - false - help for testFailover - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters testFailover --version 2023-02-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters testFailover --version 2023-02-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index 394a3a8e..1423fa61 100644 --- a/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/source/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -12,7 +12,12 @@ atlas api clusters unpinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Unpins the current fixed Feature Compatibility Version (FCV). +`Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This feature is not available for clusters on rapid release. @@ -59,18 +64,18 @@ Options - - false - help for unpinFeatureCompatibilityVersion - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api clusters unpinFeatureCompatibilityVersion --version 2024-05-30 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api clusters unpinFeatureCompatibilityVersion --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-updateCluster.txt b/source/command/atlas-api-clusters-updateCluster.txt index 8cc5ace9..2513a740 100644 --- a/source/command/atlas-api-clusters-updateCluster.txt +++ b/source/command/atlas-api-clusters-updateCluster.txt @@ -12,9 +12,14 @@ atlas api clusters updateCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster. @@ -63,18 +68,18 @@ Options - - false - help for updateCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,14 +110,13 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Updates the cluster to increase disk size to 20GB and increase node count to 5 +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Updates the cluster to increase disk size to 20GB and increase node count to 5 { "replicationSpecs": [ { @@ -133,11 +137,12 @@ Create the file below and save it as `payload.json` } .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api clusters updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false + # Updates the cluster to increase disk size to 20GB and increase node count to 5 + atlas api clusters updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index 4c520817..52458c93 100644 --- a/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/source/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -12,9 +12,14 @@ atlas api clusters updateClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration. @@ -63,18 +68,18 @@ Options - - false - help for updateClusterAdvancedConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters-upgradeSharedCluster.txt b/source/command/atlas-api-clusters-upgradeSharedCluster.txt index f0fff163..3135b27d 100644 --- a/source/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/source/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -12,9 +12,14 @@ atlas api clusters upgradeSharedCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +`Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. -To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead. @@ -62,18 +67,18 @@ Options - - false - help for upgradeSharedCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-clusters.txt b/source/command/atlas-api-clusters.txt index 3a515820..fe4ff513 100644 --- a/source/command/atlas-api-clusters.txt +++ b/source/command/atlas-api-clusters.txt @@ -12,7 +12,12 @@ atlas api clusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database deployments. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -51,25 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback at `_: Returns the internal configuration of AutoScaling for sharded clusters. -* :ref:`atlas-api-clusters-createCluster` - `Public Preview: please provide feedback at `_: Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback at `_: Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - `Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - `Public Preview: please provide feedback at `_: Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `Public Preview: please provide feedback at `_: Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `Public Preview: please provide feedback at `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - `Public Preview: please provide feedback at `_: Returns the list of regions available for the specified cloud provider at the specified tier. -* :ref:`atlas-api-clusters-listClusters` - `Public Preview: please provide feedback at `_: Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - `Public Preview: please provide feedback at `_: Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - `Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `Public Preview: please provide feedback at `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `Public Preview: please provide feedback at `_: Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - `Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `Public Preview: please provide feedback at `_: Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - `Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - `Public Preview: please provide feedback at `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. +* :ref:`atlas-api-clusters-createCluster` - `Public Preview: please provide feedback `_: Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback `_: Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - `Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `Public Preview: please provide feedback `_: Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - `Public Preview: please provide feedback `_: Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - `Public Preview: please provide feedback `_: Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - `Public Preview: please provide feedback `_: Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - `Public Preview: please provide feedback `_: Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - `Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - `Public Preview: please provide feedback `_: Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - `Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `Public Preview: please provide feedback `_: Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - `Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. .. toctree:: diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 625e4f52..01e6a8aa 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements. @@ -77,11 +82,11 @@ Options - stringArray - false - List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -115,13 +120,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H + atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index 905ffd55..5390d030 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace +`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements. @@ -69,11 +74,11 @@ Options - stringArray - false - List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -111,13 +116,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements --version 2023-11-15 --collectionName mycoll --databaseName mydb --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 + atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements --version 2023-11-15 --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 6b0bd7dc..22a88d3d 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +`Public Preview: please provide feedback `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics. @@ -53,11 +58,11 @@ Options - - false - help for getCollStatsLatencyNamespaceMetrics - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -83,13 +88,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics --version 2023-11-15 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 74615c24..e5de6a78 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +`Public Preview: please provide feedback `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster. @@ -65,11 +70,11 @@ Options - - false - help for getCollStatsLatencyNamespacesForCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -103,13 +108,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H + atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --groupId 32b6e34b3d91647abb20e7b8 --period PT10H .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 2051790e..961c57f3 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +`Public Preview: please provide feedback `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost. @@ -57,11 +62,11 @@ Options - - false - help for getCollStatsLatencyNamespacesForHost - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost --version 2023-11-15 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 + atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost --version 2023-11-15 --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index c9471e81..942648ee 100644 --- a/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/source/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics getPinnedNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +`Public Preview: please provide feedback `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces. @@ -57,11 +62,11 @@ Options - - false - help for getPinnedNamespaces - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api collectionLevelMetrics getPinnedNamespaces --version 2023-11-15 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api collectionLevelMetrics getPinnedNamespaces --version 2023-11-15 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index f78db7ee..65542d0f 100644 --- a/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics pinNamespacesPatch :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. +`Public Preview: please provide feedback `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch. @@ -61,11 +66,11 @@ Options - - false - help for pinNamespacesPatch - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index cb37fa98..3da6a1d7 100644 --- a/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/source/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics pinNamespacesPut :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +`Public Preview: please provide feedback `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. @@ -63,11 +68,11 @@ Options - - false - help for pinNamespacesPut - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index fe13083c..35988e45 100644 --- a/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/source/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics unpinNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +`Public Preview: please provide feedback `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces. @@ -61,11 +66,11 @@ Options - - false - help for unpinNamespaces - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-collectionLevelMetrics.txt b/source/command/atlas-api-collectionLevelMetrics.txt index b09f76ea..742e9e24 100644 --- a/source/command/atlas-api-collectionLevelMetrics.txt +++ b/source/command/atlas-api-collectionLevelMetrics.txt @@ -12,7 +12,12 @@ atlas api collectionLevelMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. +`Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Also returns collection level latency metric data. @@ -51,19 +56,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - `Public Preview: please provide feedback at `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - `Public Preview: please provide feedback at `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - `Public Preview: please provide feedback at `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - `Public Preview: please provide feedback at `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - `Public Preview: please provide feedback at `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `Public Preview: please provide feedback at `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - `Public Preview: please provide feedback `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - `Public Preview: please provide feedback `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - `Public Preview: please provide feedback `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +* :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - `Public Preview: please provide feedback `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - `Public Preview: please provide feedback `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `Public Preview: please provide feedback `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `Public Preview: please provide feedback `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. .. toctree:: diff --git a/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index 5a6a2d33..04532b75 100644 --- a/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -12,9 +12,14 @@ atlas api customDatabaseRoles createCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one custom role in the specified project. +`Public Preview: please provide feedback `_: Creates one custom role in the specified project. -To use this resource, the requesting API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole. @@ -59,18 +64,18 @@ Options - - false - help for createCustomDatabaseRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 7377c485..7ca62893 100644 --- a/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -12,9 +12,14 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one custom role from the specified project. +`Public Preview: please provide feedback `_: 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 Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole. @@ -55,18 +60,18 @@ Options - - false - help for deleteCustomDatabaseRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --roleName - string - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api customDatabaseRoles deleteCustomDatabaseRole --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleName [roleName] + atlas api customDatabaseRoles deleteCustomDatabaseRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleName [roleName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index fdfb1e6f..c6d675d5 100644 --- a/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -12,9 +12,14 @@ atlas api customDatabaseRoles getCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one custom role for the specified project. +`Public Preview: please provide feedback `_: Returns one custom role for the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole. @@ -55,18 +60,18 @@ Options - - false - help for getCustomDatabaseRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --roleName - string - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api customDatabaseRoles getCustomDatabaseRole --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --roleName [roleName] + atlas api customDatabaseRoles getCustomDatabaseRole --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --roleName [roleName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 05e9f8fc..10688a8a 100644 --- a/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/source/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -12,9 +12,14 @@ atlas api customDatabaseRoles listCustomDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all custom roles for the specified project. +`Public Preview: please provide feedback `_: Returns all custom roles for the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles. @@ -55,18 +60,18 @@ Options - - false - help for listCustomDatabaseRoles - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api customDatabaseRoles listCustomDatabaseRoles --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api customDatabaseRoles listCustomDatabaseRoles --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index 34edb190..e567208e 100644 --- a/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/source/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -12,9 +12,14 @@ atlas api customDatabaseRoles updateCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one custom role in the specified project. +`Public Preview: please provide feedback `_: Updates one custom role in the specified project. -To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole. @@ -59,18 +64,18 @@ Options - - false - help for updateCustomDatabaseRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --roleName - string - true diff --git a/source/command/atlas-api-customDatabaseRoles.txt b/source/command/atlas-api-customDatabaseRoles.txt index bb0a0b3c..1e366e97 100644 --- a/source/command/atlas-api-customDatabaseRoles.txt +++ b/source/command/atlas-api-customDatabaseRoles.txt @@ -12,7 +12,12 @@ atlas api customDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes custom database user privilege roles. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `Public Preview: please provide feedback at `_: Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback `_: Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `Public Preview: please provide feedback `_: Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `Public Preview: please provide feedback `_: Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `Public Preview: please provide feedback `_: Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `Public Preview: please provide feedback `_: Updates one custom role in the specified project. .. toctree:: diff --git a/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index a7dce3a6..8c994d59 100644 --- a/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/source/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api dataFederation createDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +`Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -41,7 +46,7 @@ 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. +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint. @@ -86,18 +91,18 @@ Options - - false - help for createDataFederationPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-dataFederation-createFederatedDatabase.txt b/source/command/atlas-api-dataFederation-createFederatedDatabase.txt index ffc23f5b..28c469ee 100644 --- a/source/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -12,9 +12,14 @@ atlas api dataFederation createFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one federated database instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase. @@ -59,18 +64,18 @@ Options - - false - help for createFederatedDatabase - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --skipRoleValidation - - false diff --git a/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index fd4a6ce7..f30f235c 100644 --- a/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/source/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -12,9 +12,14 @@ atlas api dataFederation createOneDataFederationQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit. @@ -71,11 +76,11 @@ Options | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index c525ec93..d5ba23fb 100644 --- a/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/source/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint. @@ -59,18 +64,18 @@ Options - - false - help for deleteDataFederationPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation deleteDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataFederation deleteDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index f950a5fa..9d2e90ef 100644 --- a/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -12,9 +12,14 @@ atlas api dataFederation deleteFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one federated database instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase. @@ -55,18 +60,18 @@ Options - - false - help for deleteFederatedDatabase - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation deleteFederatedDatabase --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api dataFederation deleteFederatedDatabase --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index f95bca18..149fc7d4 100644 --- a/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/source/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -12,9 +12,14 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. +`Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit. @@ -67,11 +72,11 @@ Options | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation deleteOneDataFederationInstanceQueryLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] + atlas api dataFederation deleteOneDataFederationInstanceQueryLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index b4f744db..44ec3de6 100644 --- a/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/source/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -12,9 +12,14 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. +`Public Preview: please provide feedback `_: 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". +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs. @@ -55,11 +60,11 @@ Options - - false - help for downloadFederatedDatabaseQueryLogs - * - --output + * - -o, --output - string - false - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -93,9 +98,7 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: diff --git a/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index 0e146393..8ffb85b0 100644 --- a/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/source/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api dataFederation getDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint. @@ -59,18 +64,18 @@ Options - - false - help for getDataFederationPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation getDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataFederation getDataFederationPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-getFederatedDatabase.txt b/source/command/atlas-api-dataFederation-getFederatedDatabase.txt index dfe9cde8..5c8c2014 100644 --- a/source/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -12,9 +12,14 @@ atlas api dataFederation getFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one federated database instance within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase. @@ -55,11 +60,11 @@ Options - - false - help for getFederatedDatabase - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation getFederatedDatabase --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] + atlas api dataFederation getFederatedDatabase --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 78b70df0..fe694fd4 100644 --- a/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/source/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -12,9 +12,14 @@ atlas api dataFederation listDataFederationPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation listDataFederationPrivateEndpoints --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api dataFederation listDataFederationPrivateEndpoints --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-listFederatedDatabases.txt b/source/command/atlas-api-dataFederation-listFederatedDatabases.txt index 9818c85c..cd15520f 100644 --- a/source/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/source/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -12,9 +12,14 @@ atlas api dataFederation listFederatedDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of all federated database instances in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases. @@ -55,18 +60,18 @@ Options - - false - help for listFederatedDatabases - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --type - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation listFederatedDatabases --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataFederation listFederatedDatabases --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index cb3fc95f..d4e0f217 100644 --- a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -12,9 +12,14 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one query limit for the specified federated database instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit. @@ -67,18 +72,18 @@ Options | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation returnFederatedDatabaseQueryLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --pretty false --tenantName [tenantName] + atlas api dataFederation returnFederatedDatabaseQueryLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index 50c64292..b215dfb5 100644 --- a/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/source/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -12,9 +12,14 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns query limits for a federated databases instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits. @@ -55,18 +60,18 @@ Options - - false - help for returnFederatedDatabaseQueryLimits - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataFederation returnFederatedDatabaseQueryLimits --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api dataFederation returnFederatedDatabaseQueryLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 9f1f2b2e..baa2fc56 100644 --- a/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/source/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -12,9 +12,14 @@ atlas api dataFederation updateFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase. @@ -59,18 +64,18 @@ Options - - false - help for updateFederatedDatabase - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --skipRoleValidation - - true diff --git a/source/command/atlas-api-dataFederation.txt b/source/command/atlas-api-dataFederation.txt index ba6872e5..9c3ef773 100644 --- a/source/command/atlas-api-dataFederation.txt +++ b/source/command/atlas-api-dataFederation.txt @@ -12,7 +12,12 @@ atlas api dataFederation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Federated Database Instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource requires your project ID. Changes to federated database instance configurations can affect costs. @@ -51,20 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `Public Preview: please provide feedback at `_: Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `Public Preview: please provide feedback at `_: Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `Public Preview: please provide feedback at `_: Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `Public Preview: please provide feedback at `_: Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `Public Preview: please provide feedback at `_: Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `Public Preview: please provide feedback at `_: Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `Public Preview: please provide feedback `_: Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `Public Preview: please provide feedback `_: Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `Public Preview: please provide feedback `_: Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `Public Preview: please provide feedback `_: Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `Public Preview: please provide feedback `_: Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `Public Preview: please provide feedback `_: Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `Public Preview: please provide feedback `_: Updates the details of one federated database instance in the specified project. .. toctree:: diff --git a/source/command/atlas-api-dataLakePipelines-createPipeline.txt b/source/command/atlas-api-dataLakePipelines-createPipeline.txt index 418a5cb7..156fa43b 100644 --- a/source/command/atlas-api-dataLakePipelines-createPipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-createPipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines createPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Creates one Data Lake Pipeline. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline. @@ -57,11 +62,11 @@ Options - - false - help for createPipeline - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-dataLakePipelines-deletePipeline.txt b/source/command/atlas-api-dataLakePipelines-deletePipeline.txt index 4693d9cf..5857f87f 100644 --- a/source/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines deletePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Removes one Data Lake Pipeline. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline. @@ -53,11 +58,11 @@ Options - - false - help for deletePipeline - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines deletePipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] + atlas api dataLakePipelines deletePipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index 3e133ec3..cddd2795 100644 --- a/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/source/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines deletePipelineRunDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes dataset that Atlas generated during the specified pipeline run. +`Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset. @@ -53,11 +58,11 @@ Options - - false - help for deletePipelineRunDataset - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines deletePipelineRunDataset --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataLakePipelines deletePipelineRunDataset --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-getPipeline.txt b/source/command/atlas-api-dataLakePipelines-getPipeline.txt index f44b59e3..0ecbbef1 100644 --- a/source/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines getPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline. @@ -55,11 +60,11 @@ Options - - false - help for getPipeline - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines getPipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines getPipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt index b3d5fab5..38b9d6a8 100644 --- a/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/source/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines getPipelineRun :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun. @@ -55,11 +60,11 @@ Options - - false - help for getPipelineRun - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -74,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines getPipelineRun --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api dataLakePipelines getPipelineRun --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pipelineRunId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 4bb70934..0891dd88 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines listPipelineRuns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. +`Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -109,13 +114,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines listPipelineRuns --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines listPipelineRuns --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index b314890c..a7cfa52f 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines listPipelineSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules. @@ -55,11 +60,11 @@ Options - - false - help for listPipelineSchedules - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines listPipelineSchedules --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines listPipelineSchedules --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index 831b4843..d3639aca 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines listPipelineSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -109,13 +114,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines listPipelineSnapshots --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines listPipelineSnapshots --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-listPipelines.txt b/source/command/atlas-api-dataLakePipelines-listPipelines.txt index c7ae3928..8eb69371 100644 --- a/source/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/source/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines listPipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. +`Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines. @@ -55,11 +60,11 @@ Options - - false - help for listPipelines - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines listPipelines --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api dataLakePipelines listPipelines --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-pausePipeline.txt b/source/command/atlas-api-dataLakePipelines-pausePipeline.txt index c3ee752b..a8b9c41b 100644 --- a/source/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines pausePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline. @@ -55,11 +60,11 @@ Options - - false - help for pausePipeline - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines pausePipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines pausePipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-resumePipeline.txt b/source/command/atlas-api-dataLakePipelines-resumePipeline.txt index 8dabc006..104c2371 100644 --- a/source/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -12,9 +12,14 @@ atlas api dataLakePipelines resumePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline. @@ -55,11 +60,11 @@ Options - - false - help for resumePipeline - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api dataLakePipelines resumePipeline --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] --pretty false + atlas api dataLakePipelines resumePipeline --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --pipelineName [pipelineName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index f0d4c711..80c7152f 100644 --- a/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/source/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines triggerSnapshotIngestion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +`Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion. @@ -57,11 +62,11 @@ Options - - false - help for triggerSnapshotIngestion - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-dataLakePipelines-updatePipeline.txt b/source/command/atlas-api-dataLakePipelines-updatePipeline.txt index 3dc916c1..5519bc5b 100644 --- a/source/command/atlas-api-dataLakePipelines-updatePipeline.txt +++ b/source/command/atlas-api-dataLakePipelines-updatePipeline.txt @@ -12,7 +12,12 @@ atlas api dataLakePipelines updatePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Updates one Data Lake Pipeline. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline. @@ -57,11 +62,11 @@ Options - - false - help for updatePipeline - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-dataLakePipelines.txt b/source/command/atlas-api-dataLakePipelines.txt index 46f5e1e5..1c79ff10 100644 --- a/source/command/atlas-api-dataLakePipelines.txt +++ b/source/command/atlas-api-dataLakePipelines.txt @@ -12,7 +12,14 @@ atlas api dataLakePipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +`Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,19 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback at `_: Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback at `_: Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback at `_: Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback at `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback at `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback at `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback at `_: Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback `_: Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback `_: Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback `_: Updates one Data Lake Pipeline. .. toctree:: diff --git a/source/command/atlas-api-databaseUsers-createDatabaseUser.txt b/source/command/atlas-api-databaseUsers-createDatabaseUser.txt index 54f67837..8aa2d47c 100644 --- a/source/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -12,9 +12,14 @@ atlas api databaseUsers createDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one database user in the specified project. +`Public Preview: please provide feedback `_: 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 role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser. @@ -59,18 +64,18 @@ Options - - false - help for createDatabaseUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,18 +98,18 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2023-01-01_aws_iam_authentication - AWS IAM Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # AWS IAM Authentication { "awsIAMType": "USER", "databaseName": "$external", @@ -130,23 +135,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # AWS IAM Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2023-01-01_ldap_authentication - LDAP Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # LDAP Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", @@ -172,23 +177,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # LDAP Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 2 :tabid: 2023-01-01_oidc_workforce_federated_authentication - OIDC Workforce Federated Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # OIDC Workforce Federated Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", @@ -214,23 +219,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # OIDC Workforce Federated Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 3 :tabid: 2023-01-01_oidc_workload_federated_authentication - OIDC Workload Federated Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # OIDC Workload Federated Authentication { "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", @@ -256,23 +261,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # OIDC Workload Federated Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 4 :tabid: 2023-01-01_scram-sha_authentication - SCRAM-SHA Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # SCRAM-SHA Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", @@ -298,23 +303,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # SCRAM-SHA Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 5 :tabid: 2023-01-01_x509_authentication - X509 Authentication - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # X509 Authentication { "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", @@ -340,11 +345,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # X509 Authentication + atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index f3144ec9..ef6511c3 100644 --- a/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -12,9 +12,14 @@ atlas api databaseUsers deleteDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one database user from the specified project. +`Public Preview: please provide feedback `_: Removes one database user from the specified project. -To use this resource, the requesting API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser. @@ -59,25 +64,25 @@ Options - - false - help for deleteDatabaseUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - true - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | - |---|---|---|---| + | AWS IAM | awsIAMType | ROLE | ARN | | AWS IAM | awsIAMType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | @@ -110,13 +115,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api databaseUsers deleteDatabaseUser --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName + atlas api databaseUsers deleteDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-getDatabaseUser.txt b/source/command/atlas-api-databaseUsers-getDatabaseUser.txt index 0ed568d6..031d4bb0 100644 --- a/source/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -12,9 +12,14 @@ atlas api databaseUsers getDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one database user that belong to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser. @@ -59,25 +64,25 @@ Options - - false - help for getDatabaseUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - true - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | - |---|---|---|---| + | AWS IAM | awsIAMType | ROLE | ARN | | AWS IAM | awsIAMType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | @@ -110,13 +115,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api databaseUsers getDatabaseUser --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName + atlas api databaseUsers getDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt index be04e97f..9085da29 100644 --- a/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/source/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -12,9 +12,14 @@ atlas api databaseUsers listDatabaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all database users that belong to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api databaseUsers listDatabaseUsers --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api databaseUsers listDatabaseUsers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 02454cac..06b5df3c 100644 --- a/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/source/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -12,9 +12,14 @@ atlas api databaseUsers updateDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. +`Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. -To use this resource, the requesting API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser. @@ -63,25 +68,25 @@ Options - - false - help for updateDatabaseUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - true - Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | - |---|---|---|---| + | AWS IAM | awsIAMType | ROLE | ARN | | AWS IAM | awsIAMType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | diff --git a/source/command/atlas-api-databaseUsers.txt b/source/command/atlas-api-databaseUsers.txt index 946715b8..8b6f4986 100644 --- a/source/command/atlas-api-databaseUsers.txt +++ b/source/command/atlas-api-databaseUsers.txt @@ -12,7 +12,14 @@ atlas api databaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database users. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback at `_: Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `Public Preview: please provide feedback at `_: Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `Public Preview: please provide feedback at `_: Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `Public Preview: please provide feedback at `_: Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback `_: Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `Public Preview: please provide feedback `_: Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `Public Preview: please provide feedback `_: Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `Public Preview: please provide feedback `_: Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. .. toctree:: diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 8eb40a9d..96c11f60 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. +`Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint. @@ -61,18 +66,18 @@ Options - - false - help for createEncryptionAtRestPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 40f503bf..e39d2e65 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -12,9 +12,14 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. @@ -58,18 +63,18 @@ Options - - false - help for getEncryptionAtRest - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -92,13 +97,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 92adfca3..99842e0c 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint. @@ -61,18 +66,18 @@ Options - - false - help for getEncryptionAtRestPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 8fe0cfdf..144fd4f2 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +`Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider. @@ -65,11 +70,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -80,7 +85,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -103,13 +108,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider --version 2023-01-01 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 3556e617..f6e86270 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion. @@ -61,18 +66,18 @@ Options - - false - help for requestEncryptionAtRestPrivateEndpointDeletion - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index dc57b2de..b23f0f2e 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -12,9 +12,14 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. 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. @@ -62,18 +67,18 @@ Options - - false - help for updateEncryptionAtRest - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index de3690c0..13e51960 100644 --- a/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/source/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -12,7 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. +`Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud encrypts all storage whether or not you use your own key management. @@ -51,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `Public Preview: please provide feedback at `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback at `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `Public Preview: please provide feedback at `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `Public Preview: please provide feedback at `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `Public Preview: please provide feedback at `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `Public Preview: please provide feedback `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `Public Preview: please provide feedback `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. .. toctree:: diff --git a/source/command/atlas-api-events-getOrganizationEvent.txt b/source/command/atlas-api-events-getOrganizationEvent.txt index bdf09323..2e2390af 100644 --- a/source/command/atlas-api-events-getOrganizationEvent.txt +++ b/source/command/atlas-api-events-getOrganizationEvent.txt @@ -12,9 +12,14 @@ atlas api events getOrganizationEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one event for the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return All Events from One Organization endpoint to retrieve all events to which the authenticated user has access. This resource remains under revision and may change. @@ -51,7 +56,7 @@ Options * - --eventId - string - true - - Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the event that you want to return. * - -h, --help - - false @@ -64,18 +69,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -98,13 +103,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api events getOrganizationEvent --version 2023-01-01 --envelope false --eventId [eventId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api events getOrganizationEvent --version 2023-01-01 --eventId [eventId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events-getProjectEvent.txt b/source/command/atlas-api-events-getProjectEvent.txt index b8b5a87b..66515496 100644 --- a/source/command/atlas-api-events-getProjectEvent.txt +++ b/source/command/atlas-api-events-getProjectEvent.txt @@ -12,9 +12,14 @@ atlas api events getProjectEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one event for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Events from One Project endpoint to retrieve all events to which the authenticated user has access. This resource remains under revision and may change. @@ -51,7 +56,7 @@ Options * - --eventId - string - true - - Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access. + - Unique 24-hexadecimal digit string that identifies the event that you want to return. * - --groupId - string - true @@ -66,18 +71,18 @@ Options - - false - Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -100,13 +105,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api events getProjectEvent --version 2023-01-01 --envelope false --eventId [eventId] --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api events getProjectEvent --version 2023-01-01 --eventId [eventId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events-listEventTypes.txt b/source/command/atlas-api-events-listEventTypes.txt index 3c2913fd..595372c8 100644 --- a/source/command/atlas-api-events-listEventTypes.txt +++ b/source/command/atlas-api-events-listEventTypes.txt @@ -12,7 +12,12 @@ atlas api events listEventTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of all event types, along with a description and additional metadata about each event. +`Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes. @@ -55,11 +60,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -92,14 +97,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api events listEventTypes --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-events-listOrganizationEvents.txt b/source/command/atlas-api-events-listOrganizationEvents.txt index 2f883572..5c44c570 100644 --- a/source/command/atlas-api-events-listOrganizationEvents.txt +++ b/source/command/atlas-api-events-listOrganizationEvents.txt @@ -12,9 +12,14 @@ atlas api events listOrganizationEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all events for the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This resource remains under revision and may change. @@ -82,11 +87,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -97,7 +102,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -120,13 +125,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api events listOrganizationEvents --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api events listOrganizationEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events-listProjectEvents.txt b/source/command/atlas-api-events-listProjectEvents.txt index 726aa9ef..df9efac2 100644 --- a/source/command/atlas-api-events-listProjectEvents.txt +++ b/source/command/atlas-api-events-listProjectEvents.txt @@ -12,9 +12,14 @@ atlas api events listProjectEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all events for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This resource remains under revision and may change. @@ -94,11 +99,11 @@ Options - string - false - Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -109,7 +114,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -132,13 +137,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api events listProjectEvents --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api events listProjectEvents --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-events.txt b/source/command/atlas-api-events.txt index d7ffbcbb..20eb7fa2 100644 --- a/source/command/atlas-api-events.txt +++ b/source/command/atlas-api-events.txt @@ -12,7 +12,12 @@ atlas api events :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns events. +`Public Preview: please provide feedback `_: Returns events. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This collection remains under revision and may change. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback at `_: Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback at `_: Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - `Public Preview: please provide feedback at `_: Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - `Public Preview: please provide feedback at `_: Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback at `_: Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - `Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - `Public Preview: please provide feedback `_: Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback `_: Returns all events for the specified project. .. toctree:: diff --git a/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index c1c66486..d96edc07 100644 --- a/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication createIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or 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. @@ -60,11 +65,11 @@ Options - - false - help for createIdentityProvider - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 8a93dbdf..0413ffe3 100644 --- a/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication createRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping. @@ -61,11 +66,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index ecb6614d..bae51741 100644 --- a/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/source/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication deleteFederationApp :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp. @@ -49,11 +54,11 @@ Options - - false - help for deleteFederationApp - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -79,9 +84,7 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: diff --git a/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index db78c5f0..03f1637f 100644 --- a/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -12,12 +12,17 @@ atlas api federatedAuthentication deleteIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -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. + +To use this resource, the requesting Service Account or 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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider. @@ -60,11 +65,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the identity provider to connect. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -90,13 +95,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication deleteIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index 225a7c73..758e600c 100644 --- a/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication deleteRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping. @@ -61,11 +66,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication deleteRoleMapping --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 + atlas api federatedAuthentication deleteRoleMapping --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index b612f967..346f82f7 100644 --- a/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/source/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication getConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig. @@ -57,11 +62,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication getConnectedOrgConfig --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication getConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt index c811ff41..b864992b 100644 --- a/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/source/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication getFederationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication getFederationSettings --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api federatedAuthentication getFederationSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 6e08e04b..3a45f7c8 100644 --- a/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication getIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider. @@ -57,11 +62,11 @@ Options - string - true - Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 5167bc8b..b74f7fbc 100644 --- a/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/source/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication getIdentityProviderMetadata :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata. @@ -53,11 +58,11 @@ Options - string - true - Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -83,9 +88,7 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: diff --git a/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt index be740768..5d3a151e 100644 --- a/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication getRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping. @@ -61,11 +66,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication getRoleMapping --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 + atlas api federatedAuthentication getRoleMapping --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --id 32b6e34b3d91647abb20e7b8 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index a7f64d7a..5bf8868e 100644 --- a/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/source/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication listConnectedOrgConfigs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs. @@ -57,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication listConnectedOrgConfigs --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1 + atlas api federatedAuthentication listConnectedOrgConfigs --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 2aa006a0..31f1d08c 100644 --- a/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/source/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication listIdentityProviders :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders. @@ -61,11 +66,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1 + atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 526eade3..1bf67600 100644 --- a/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/source/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication listRoleMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings. @@ -57,11 +62,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication listRoleMappings --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --orgId 4888442a3354817a7320eb61 + atlas api federatedAuthentication listRoleMappings --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index fd57c557..f172ec3d 100644 --- a/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/source/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication removeConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig. @@ -57,11 +62,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication removeConnectedOrgConfig --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication removeConnectedOrgConfig --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --orgId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index 44dad211..c308a52e 100644 --- a/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -12,12 +12,17 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -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. + +To use this resource, the requesting Service Account or 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. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider. @@ -60,11 +65,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the identity provider to connect. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -90,13 +95,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api federatedAuthentication revokeJwksFromIdentityProvider --version 2023-11-15 --envelope false --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 + atlas api federatedAuthentication revokeJwksFromIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 8f260a9a..de8bcefa 100644 --- a/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/source/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication updateConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. +`Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. -To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or 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. @@ -73,11 +78,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 18849857..d1f15920 100644 --- a/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/source/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication updateIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or 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. @@ -64,11 +69,11 @@ Options - string - true - Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index 3cf7210f..03877d83 100644 --- a/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/source/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -12,9 +12,14 @@ atlas api federatedAuthentication updateRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping. @@ -65,11 +70,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-federatedAuthentication.txt b/source/command/atlas-api-federatedAuthentication.txt index 7c462306..fe3858d0 100644 --- a/source/command/atlas-api-federatedAuthentication.txt +++ b/source/command/atlas-api-federatedAuthentication.txt @@ -12,7 +12,14 @@ atlas api federatedAuthentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,24 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback `_: Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `Public Preview: please provide feedback `_: Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `Public Preview: please provide feedback `_: Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `Public Preview: please provide feedback `_: Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `Public Preview: please provide feedback `_: Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `Public Preview: please provide feedback `_: Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `Public Preview: please provide feedback `_: Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `Public Preview: please provide feedback `_: Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `Public Preview: please provide feedback `_: Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `Public Preview: please provide feedback `_: Updates one role mapping in the specified organization in the specified federation. .. toctree:: diff --git a/source/command/atlas-api-flexClusters-createFlexCluster.txt b/source/command/atlas-api-flexClusters-createFlexCluster.txt index 1cfb7808..9ad973ef 100644 --- a/source/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-createFlexCluster.txt @@ -12,9 +12,14 @@ atlas api flexClusters createFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster. @@ -59,18 +64,18 @@ Options - - false - help for createFlexCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexClusters-deleteFlexCluster.txt b/source/command/atlas-api-flexClusters-deleteFlexCluster.txt index 9c8e67c1..14e91c72 100644 --- a/source/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -12,9 +12,14 @@ atlas api flexClusters deleteFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster. @@ -59,18 +64,18 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexClusters deleteFlexCluster --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api flexClusters deleteFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexClusters-getFlexCluster.txt b/source/command/atlas-api-flexClusters-getFlexCluster.txt index a47666ea..5a89576a 100644 --- a/source/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-getFlexCluster.txt @@ -12,9 +12,14 @@ atlas api flexClusters getFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one flex cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster. @@ -59,18 +64,18 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexClusters getFlexCluster --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api flexClusters getFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexClusters-listFlexClusters.txt b/source/command/atlas-api-flexClusters-listFlexClusters.txt index 6294467e..7d459df5 100644 --- a/source/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/source/command/atlas-api-flexClusters-listFlexClusters.txt @@ -12,9 +12,14 @@ atlas api flexClusters listFlexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all flex clusters in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexClusters listFlexClusters --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api flexClusters listFlexClusters --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexClusters-updateFlexCluster.txt b/source/command/atlas-api-flexClusters-updateFlexCluster.txt index 3dab221d..fa746bd4 100644 --- a/source/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -12,9 +12,14 @@ atlas api flexClusters updateFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster. @@ -63,18 +68,18 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 92d552ca..06871287 100644 --- a/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/source/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -12,9 +12,14 @@ atlas api flexClusters upgradeFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster. @@ -59,18 +64,18 @@ Options - - false - help for upgradeFlexCluster - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexClusters.txt b/source/command/atlas-api-flexClusters.txt index 59baa45a..26006f16 100644 --- a/source/command/atlas-api-flexClusters.txt +++ b/source/command/atlas-api-flexClusters.txt @@ -12,7 +12,14 @@ atlas api flexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes flex clusters. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - `Public Preview: please provide feedback at `_: Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - `Public Preview: please provide feedback at `_: Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - `Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `Public Preview: please provide feedback `_: Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - `Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - `Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - `Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `Public Preview: please provide feedback `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. .. toctree:: diff --git a/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index 1b720e6f..cc7aa3f0 100644 --- a/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/source/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob. @@ -63,18 +68,18 @@ Options - string - true - Human-readable label that identifies the flex cluster whose snapshot you want to restore. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 951e080e..5976a2d6 100644 --- a/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/source/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob. @@ -59,18 +64,18 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --restoreJobId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexRestoreJobs getFlexBackupRestoreJob --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false --restoreJobId [restoreJobId] + atlas api flexRestoreJobs getFlexBackupRestoreJob --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] --restoreJobId [restoreJobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 6eded9c3..59f21797 100644 --- a/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/source/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -12,9 +12,14 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs. @@ -67,11 +72,11 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexRestoreJobs listFlexBackupRestoreJobs --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --name [name] --pageNum 1 --pretty false + atlas api flexRestoreJobs listFlexBackupRestoreJobs --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexRestoreJobs.txt b/source/command/atlas-api-flexRestoreJobs.txt index 6b23cc00..60d27b2e 100644 --- a/source/command/atlas-api-flexRestoreJobs.txt +++ b/source/command/atlas-api-flexRestoreJobs.txt @@ -12,7 +12,14 @@ atlas api flexRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and adds restore jobs for flex database deployments. +`Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for one flex cluster from the specified project. .. toctree:: diff --git a/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index 1cd77d24..2ba61c89 100644 --- a/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/source/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -12,9 +12,14 @@ atlas api flexSnapshots downloadFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup. @@ -63,18 +68,18 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-flexSnapshots-getFlexBackup.txt b/source/command/atlas-api-flexSnapshots-getFlexBackup.txt index 48bc304e..89c4a960 100644 --- a/source/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/source/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -12,9 +12,14 @@ atlas api flexSnapshots getFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup. @@ -59,11 +64,11 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexSnapshots getFlexBackup --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --snapshotId 32b6e34b3d91647abb20e7b8 + atlas api flexSnapshots getFlexBackup --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] --snapshotId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexSnapshots-listFlexBackups.txt b/source/command/atlas-api-flexSnapshots-listFlexBackups.txt index 3274df85..fea9a620 100644 --- a/source/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/source/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -12,9 +12,14 @@ atlas api flexSnapshots listFlexBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups. @@ -67,11 +72,11 @@ Options - string - true - Human-readable label that identifies the flex cluster. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api flexSnapshots listFlexBackups --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --name [name] --pageNum 1 --pretty false + atlas api flexSnapshots listFlexBackups --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-flexSnapshots.txt b/source/command/atlas-api-flexSnapshots.txt index 3a42b486..68eed674 100644 --- a/source/command/atlas-api-flexSnapshots.txt +++ b/source/command/atlas-api-flexSnapshots.txt @@ -12,7 +12,14 @@ atlas api flexSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and requests to download flex database deployment snapshots. +`Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project. .. toctree:: diff --git a/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 663f9100..dd48c0a2 100644 --- a/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/source/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -12,9 +12,14 @@ atlas api globalClusters createCustomZoneMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping. @@ -63,18 +68,18 @@ Options - - false - help for createCustomZoneMapping - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-globalClusters-createManagedNamespace.txt b/source/command/atlas-api-globalClusters-createManagedNamespace.txt index e8c35432..836a0e50 100644 --- a/source/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/source/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -12,9 +12,14 @@ atlas api globalClusters createManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace. @@ -63,18 +68,18 @@ Options - - false - help for createManagedNamespace - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index c76e0ab8..e84ef6d3 100644 --- a/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/source/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -12,9 +12,14 @@ atlas api globalClusters deleteAllCustomZoneMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings. @@ -59,18 +64,18 @@ Options - - false - help for deleteAllCustomZoneMappings - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api globalClusters deleteAllCustomZoneMappings --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api globalClusters deleteAllCustomZoneMappings --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt index fef8c06f..62652b00 100644 --- a/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/source/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -12,9 +12,14 @@ atlas api globalClusters deleteManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace. @@ -67,18 +72,18 @@ Options - - false - help for deleteManagedNamespace - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api globalClusters deleteManagedNamespace --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api globalClusters deleteManagedNamespace --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-globalClusters-getManagedNamespace.txt b/source/command/atlas-api-globalClusters-getManagedNamespace.txt index 9f8e5eef..216ecbbd 100644 --- a/source/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/source/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -12,9 +12,14 @@ atlas api globalClusters getManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace. @@ -59,18 +64,18 @@ Options - - false - help for getManagedNamespace - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api globalClusters getManagedNamespace --version 2024-08-05 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api globalClusters getManagedNamespace --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-globalClusters.txt b/source/command/atlas-api-globalClusters.txt index d80a740f..61febfcb 100644 --- a/source/command/atlas-api-globalClusters.txt +++ b/source/command/atlas-api-globalClusters.txt @@ -12,7 +12,12 @@ atlas api globalClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +`Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection. MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is city, the compound shard key is location, city. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the Global Cluster Configuration pane when you create or modify your Global Cluster. @@ -52,11 +57,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - `Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - `Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - `Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - `Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster. .. toctree:: diff --git a/source/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/source/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index 77741a84..5143f921 100644 --- a/source/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/source/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -12,7 +12,12 @@ atlas api invoices createCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a query process within the Cost Explorer for the given parameters. +`Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -57,11 +62,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-invoices-downloadInvoiceCsv.txt b/source/command/atlas-api-invoices-downloadInvoiceCsv.txt index e74bb628..9faae27c 100644 --- a/source/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/source/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -12,9 +12,14 @@ atlas api invoices downloadInvoiceCsv :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv. @@ -58,18 +63,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["csv"] This value defaults to "csv". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -92,13 +97,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api invoices downloadInvoiceCsv --version 2023-01-01 --envelope false --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api invoices downloadInvoiceCsv --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 35d0dd0f..52cdf5b4 100644 --- a/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/source/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -12,7 +12,12 @@ atlas api invoices getCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +`Public Preview: please provide feedback `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -53,11 +58,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - true - preferred api format, can be ["csv", "json", go-template] - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api invoices getCostExplorerQueryProcess --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --token 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C + atlas api invoices getCostExplorerQueryProcess --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --token 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-getInvoice.txt b/source/command/atlas-api-invoices-getInvoice.txt index b2ae85ee..1fc096b9 100644 --- a/source/command/atlas-api-invoices-getInvoice.txt +++ b/source/command/atlas-api-invoices-getInvoice.txt @@ -12,9 +12,14 @@ atlas api invoices getInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice. @@ -58,18 +63,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - true - preferred api format, can be ["csv", "json", go-template] - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -92,13 +97,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api invoices getInvoice --version 2023-01-01 --envelope false --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api invoices getInvoice --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-listInvoices.txt b/source/command/atlas-api-invoices-listInvoices.txt index ada81e0e..39093e0c 100644 --- a/source/command/atlas-api-invoices-listInvoices.txt +++ b/source/command/atlas-api-invoices-listInvoices.txt @@ -12,9 +12,14 @@ atlas api invoices listInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices. @@ -70,11 +75,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,7 +90,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --sortBy - string - false @@ -124,13 +129,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api invoices listInvoices --version 2023-01-01 --envelope false --fromDate 2023-01-01 --includeCount true --itemsPerPage 100 --orderBy desc --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false --toDate 2023-01-01 + atlas api invoices listInvoices --version 2023-01-01 --fromDate 2023-01-01 --orderBy desc --orgId 4888442a3354817a7320eb61 --toDate 2023-01-01 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-listPendingInvoices.txt b/source/command/atlas-api-invoices-listPendingInvoices.txt index e21a4bf1..5554d0cf 100644 --- a/source/command/atlas-api-invoices-listPendingInvoices.txt +++ b/source/command/atlas-api-invoices-listPendingInvoices.txt @@ -12,9 +12,14 @@ atlas api invoices listPendingInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api invoices listPendingInvoices --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api invoices listPendingInvoices --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/source/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index a09ed111..825e0200 100644 --- a/source/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/source/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -12,7 +12,12 @@ atlas api invoices queryLineItemsFromSingleInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Query the lineItems of the specified invoice and return the result JSON. +`Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + A unique 24-hexadecimal digit string identifies the invoice. @@ -65,11 +70,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-invoices.txt b/source/command/atlas-api-invoices.txt index 9187866a..4918bd11 100644 --- a/source/command/atlas-api-invoices.txt +++ b/source/command/atlas-api-invoices.txt @@ -12,7 +12,14 @@ atlas api invoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns invoices. +`Public Preview: please provide feedback `_: Returns invoices. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,13 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback at `_: Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `Public Preview: please provide feedback at `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. -* :ref:`atlas-api-invoices-getInvoice` - `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - `Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - `Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `Public Preview: please provide feedback at `_: Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +* :ref:`atlas-api-invoices-getInvoice` - `Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listInvoices` - `Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - `Public Preview: please provide feedback `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. .. toctree:: diff --git a/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index 30d8689e..5235e625 100644 --- a/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -12,9 +12,14 @@ atlas api ldapConfiguration deleteLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration. @@ -55,18 +60,18 @@ Options - - false - help for deleteLdapConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api ldapConfiguration deleteLdapConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api ldapConfiguration deleteLdapConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index e74648b2..dadc5f73 100644 --- a/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -12,9 +12,14 @@ atlas api ldapConfiguration getLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the current LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration. @@ -55,18 +60,18 @@ Options - - false - help for getLdapConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api ldapConfiguration getLdapConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api ldapConfiguration getLdapConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 669cb6bd..296155db 100644 --- a/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/source/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -12,9 +12,14 @@ atlas api ldapConfiguration getLdapConfigurationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of one request to verify one LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus. @@ -55,22 +60,22 @@ Options - - false - help for getLdapConfigurationStatus - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --requestId - string - true - - Unique string that identifies the request to verify an LDAP configuration. + - Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api ldapConfiguration getLdapConfigurationStatus --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --requestId [requestId] + atlas api ldapConfiguration getLdapConfigurationStatus --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --requestId [requestId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index b3e0f5d5..ed910052 100644 --- a/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -12,9 +12,14 @@ atlas api ldapConfiguration saveLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Edits the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. @@ -62,18 +67,18 @@ Options - - false - help for saveLdapConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index ef48dbcc..8e18612f 100644 --- a/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -12,9 +12,14 @@ atlas api ldapConfiguration verifyLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration. @@ -59,18 +64,18 @@ Options - - false - help for verifyLdapConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-ldapConfiguration.txt b/source/command/atlas-api-ldapConfiguration.txt index d8232a70..c56abd52 100644 --- a/source/command/atlas-api-ldapConfiguration.txt +++ b/source/command/atlas-api-ldapConfiguration.txt @@ -12,7 +12,12 @@ atlas api ldapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, verifies, and removes LDAP configurations. +`Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `Public Preview: please provide feedback at `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - `Public Preview: please provide feedback at `_: Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `Public Preview: please provide feedback at `_: Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `Public Preview: please provide feedback at `_: Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `Public Preview: please provide feedback `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - `Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `Public Preview: please provide feedback `_: Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. .. toctree:: diff --git a/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index 60af752b..b031878d 100644 --- a/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/source/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api legacyBackup createLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob. @@ -63,18 +68,18 @@ Options - - false - help for createLegacyBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 7c304b71..6c35abdb 100644 --- a/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/source/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -12,9 +12,14 @@ atlas api legacyBackup deleteLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot. @@ -59,18 +64,18 @@ Options - - false - help for deleteLegacySnapshot - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup deleteLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api legacyBackup deleteLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index a5835f05..ead0159c 100644 --- a/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/source/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -12,9 +12,14 @@ atlas api legacyBackup getLegacyBackupCheckpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint. @@ -63,18 +68,18 @@ Options - - false - help for getLegacyBackupCheckpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup getLegacyBackupCheckpoint --version 2023-01-01 --checkpointId [checkpointId] --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api legacyBackup getLegacyBackupCheckpoint --version 2023-01-01 --checkpointId [checkpointId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 33026509..07b2ef6f 100644 --- a/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/source/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api legacyBackup getLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. @@ -66,18 +71,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the restore job. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -100,13 +105,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup getLegacyBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId] --pretty false + atlas api legacyBackup getLegacyBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt index b0d1b460..50ee7fc7 100644 --- a/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/source/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -12,9 +12,14 @@ atlas api legacyBackup getLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot. @@ -59,18 +64,18 @@ Options - - false - help for getLegacySnapshot - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index 35cb0162..71b67a5f 100644 --- a/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/source/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -12,9 +12,14 @@ atlas api legacyBackup getLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. @@ -62,18 +67,18 @@ Options - - false - help for getLegacySnapshotSchedule - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup getLegacySnapshotSchedule --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api legacyBackup getLegacySnapshotSchedule --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 7bdd6357..14621548 100644 --- a/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/source/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -12,9 +12,14 @@ atlas api legacyBackup listLegacyBackupCheckpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup listLegacyBackupCheckpoints --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api legacyBackup listLegacyBackupCheckpoints --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index 67568508..6aa00340 100644 --- a/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/source/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -12,9 +12,14 @@ atlas api legacyBackup listLegacyBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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. @@ -74,11 +79,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,7 +94,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -112,13 +117,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup listLegacyBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api legacyBackup listLegacyBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt index f69edb5a..62e6f960 100644 --- a/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/source/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -12,9 +12,14 @@ atlas api legacyBackup listLegacySnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots. @@ -71,11 +76,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -109,13 +114,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api legacyBackup listLegacySnapshots --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api legacyBackup listLegacySnapshots --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index ef11c09c..98f6d6b2 100644 --- a/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/source/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -12,9 +12,14 @@ atlas api legacyBackup updateLegacySnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention. @@ -63,18 +68,18 @@ Options - - false - help for updateLegacySnapshotRetention - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true diff --git a/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index 3a8f3cbc..02367dea 100644 --- a/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/source/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -12,9 +12,14 @@ atlas api legacyBackup updateLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the snapshot schedule for one cluster in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. @@ -66,18 +71,18 @@ Options - - false - help for updateLegacySnapshotSchedule - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-legacyBackup.txt b/source/command/atlas-api-legacyBackup.txt index 51c76213..305203aa 100644 --- a/source/command/atlas-api-legacyBackup.txt +++ b/source/command/atlas-api-legacyBackup.txt @@ -12,7 +12,14 @@ atlas api legacyBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +`Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,17 +56,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `Public Preview: please provide feedback at `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `Public Preview: please provide feedback at `_: Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `Public Preview: please provide feedback `_: Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `Public Preview: please provide feedback `_: Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `Public Preview: please provide feedback `_: Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `Public Preview: please provide feedback `_: Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `Public Preview: please provide feedback `_: Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `Public Preview: please provide feedback `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project. .. toctree:: diff --git a/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index 5ec6bc27..5cf1fe2e 100644 --- a/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -12,9 +12,14 @@ atlas api maintenanceWindows deferMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow. @@ -55,11 +60,11 @@ Options - - false - help for deferMaintenanceWindow - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api maintenanceWindows deferMaintenanceWindow --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api maintenanceWindows deferMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 864b07e3..6405339c 100644 --- a/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -12,9 +12,14 @@ atlas api maintenanceWindows getMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow. @@ -55,18 +60,18 @@ Options - - false - help for getMaintenanceWindow - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api maintenanceWindows getMaintenanceWindow --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api maintenanceWindows getMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index 51ff5d2f..4d21ca22 100644 --- a/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -12,9 +12,14 @@ atlas api maintenanceWindows resetMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow. @@ -55,11 +60,11 @@ Options - - false - help for resetMaintenanceWindow - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api maintenanceWindows resetMaintenanceWindow --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api maintenanceWindows resetMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 1323a7ca..8849ffdc 100644 --- a/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/source/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -12,9 +12,14 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer. @@ -55,11 +60,11 @@ Options - - false - help for toggleMaintenanceAutoDefer - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api maintenanceWindows toggleMaintenanceAutoDefer --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api maintenanceWindows toggleMaintenanceAutoDefer --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index cbd70725..24b7e7e4 100644 --- a/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/source/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -12,9 +12,14 @@ atlas api maintenanceWindows updateMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow. @@ -59,11 +64,11 @@ Options - - false - help for updateMaintenanceWindow - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-maintenanceWindows.txt b/source/command/atlas-api-maintenanceWindows.txt index f9afbf26..85b2397d 100644 --- a/source/command/atlas-api-maintenanceWindows.txt +++ b/source/command/atlas-api-maintenanceWindows.txt @@ -12,7 +12,12 @@ atlas api maintenanceWindows :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes maintenance windows. +`Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback `_: Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `Public Preview: please provide feedback `_: Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `Public Preview: please provide feedback `_: Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `Public Preview: please provide feedback `_: Updates the maintenance window for the specified project. .. toctree:: diff --git a/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index 910eada7..938d8720 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers addOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This operation is atomic. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 37e5f313..22a58471 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers addProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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. @@ -62,18 +67,18 @@ Options - - false - help for addProjectRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 9f742f35..1c050c23 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers addProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -69,18 +74,18 @@ Options - - false - help for addProjectUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 038b954d..f217ce6e 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers addUserToTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -60,18 +65,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index c956c043..9d872353 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers createOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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. @@ -60,18 +65,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-mongoDbCloudUsers-createUser.txt b/source/command/atlas-api-mongoDbCloudUsers-createUser.txt index c4a61ad2..72c2f8a3 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -12,7 +12,12 @@ atlas api mongoDbCloudUsers createUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one MongoDB Cloud user account. +`Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -20,7 +25,7 @@ A MongoDB Cloud user account grants access to only the MongoDB Cloud application 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. +To use this resource, the requesting Service Account or API Key can have any role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser. @@ -59,18 +64,18 @@ Options - - false - help for createUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index 5b1d9250..2756bd8a 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers getOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +`Public Preview: please provide feedback `_: 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 Member role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Member 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. @@ -59,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --userId [userId] + atlas api mongoDbCloudUsers getOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 4ec13f06..6b4c1d40 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers getProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. +`Public Preview: please provide feedback `_: 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 Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project 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. @@ -61,18 +66,18 @@ Options - - false - help for getProjectUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers getProjectUser --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --userId [userId] + atlas api mongoDbCloudUsers getProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-getUser.txt b/source/command/atlas-api-mongoDbCloudUsers-getUser.txt index 59634d9f..0d024457 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers getUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser. @@ -49,18 +54,18 @@ Options - - false - help for getUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true @@ -86,14 +91,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api mongoDbCloudUsers getUser --version 2023-01-01 --envelope false --pretty false --userId [userId] - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 85617340..c3a7d545 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers getUserByUsername :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified username. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername. @@ -49,18 +54,18 @@ Options - - false - help for getUserByUsername - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userName - string - true @@ -86,14 +91,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api mongoDbCloudUsers getUserByUsername --version 2023-01-01 --envelope false --pretty false --userName [userName] - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index 38b61659..286270a8 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers listOrganizationUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -To use this resource, the requesting API Key must have the Organization Member role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -71,11 +76,11 @@ Options - string - false - Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - false @@ -113,13 +118,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --pageNum 1 --pretty false + atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index eefeb367..ea9acd0a 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers listProjectUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -81,11 +86,11 @@ Options - string - false - Flag that indicates whether to filter the returned list by users organization membership status. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -96,7 +101,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - false @@ -123,13 +128,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers listProjectUsers --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --orgMembershipStatus ACTIVE --pageNum 1 --pretty false + atlas api mongoDbCloudUsers listProjectUsers --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --orgMembershipStatus ACTIVE .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 69bcb6fe..d46df620 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers listTeamUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. -Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -67,11 +72,11 @@ Options - string - false - Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true @@ -113,13 +118,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers listTeamUsers --version 2025-02-19 --envelope false --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --pageNum 1 --pretty false --teamId [teamId] + atlas api mongoDbCloudUsers listTeamUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 18fd956f..7929448f 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers removeOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization-level role from the MongoDB Cloud user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This operation is atomic. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index 7d43c9f4..73f7455a 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers removeOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -59,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers removeOrganizationUser --version 2025-02-19 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --userId [userId] + atlas api mongoDbCloudUsers removeOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 36703b70..6249b601 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers removeProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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. @@ -62,18 +67,18 @@ Options - - false - help for removeProjectRole - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index 9566e94d..5f04240f 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers removeProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. -You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Note: This resource cannot be used to remove pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -61,18 +66,18 @@ Options - - false - help for removeProjectUser - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api mongoDbCloudUsers removeProjectUser --version 2025-02-19 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --userId [userId] + atlas api mongoDbCloudUsers removeProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index 51dd80ed..d860ff38 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers removeUserFromTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. @@ -60,18 +65,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index ed4710b6..83fc8ba2 100644 --- a/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/source/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -12,9 +12,14 @@ atlas api mongoDbCloudUsers updateOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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. @@ -63,18 +68,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-mongoDbCloudUsers.txt b/source/command/atlas-api-mongoDbCloudUsers.txt index 1d60ef21..55ecbf81 100644 --- a/source/command/atlas-api-mongoDbCloudUsers.txt +++ b/source/command/atlas-api-mongoDbCloudUsers.txt @@ -12,7 +12,14 @@ atlas api mongoDbCloudUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits MongoDB Cloud users. +`Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,25 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `Public Preview: please provide feedback at `_: Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - `Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - `Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - `Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `Public Preview: please provide feedback at `_: Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `Public Preview: please provide feedback `_: Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization. .. toctree:: diff --git a/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index eaa9cf21..ef0a8dd0 100644 --- a/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/source/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs getAtlasProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the processes for the specified host for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess. @@ -55,18 +60,18 @@ Options - - false - help for getAtlasProcess - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getAtlasProcess --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getAtlasProcess --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getDatabase.txt b/source/command/atlas-api-monitoringAndLogs-getDatabase.txt index 25498897..fdb236d5 100644 --- a/source/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/source/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs getDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one database running on the specified host for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase. @@ -59,18 +64,18 @@ Options - - false - help for getDatabase - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getDatabase --version 2023-01-01 --databaseName [databaseName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getDatabase --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 7791030e..18efcdcc 100644 --- a/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs getDatabaseMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements. @@ -71,11 +76,11 @@ Options - m - false - One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -117,13 +122,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index e530fc6f..549a2a6d 100644 --- a/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the measurements of one disk or partition for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Returned value can be one of the following: @@ -31,7 +36,7 @@ Amount of free and used disk space on the disk partition used for the MongoDB pr -To use this resource, the requesting API Key must have the Project Read Only role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements. @@ -84,11 +89,11 @@ Options - m - false - One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -103,7 +108,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -134,13 +139,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getDiskMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getDiskMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt index 01e2f01c..594a5d2f 100644 --- a/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/source/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs getHostLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +`Public Preview: please provide feedback `_: 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". +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs. @@ -67,11 +72,11 @@ Options - string - true - Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project. - * - --output + * - -o, --output - string - false - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -101,15 +106,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns a compressed (.gz) MongoDB log file containing log messages for the specified host - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --envelope false --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200 + # Returns a compressed (.gz) MongoDB log file containing log messages for the specified host + atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index ebb68a76..2930f78e 100644 --- a/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Returned value can be one of the following: @@ -34,7 +39,7 @@ Measurements for the host, such as CPU usage or number of I/O operations -To use this resource, the requesting API Key must have the Project Read Only role. +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements. @@ -87,11 +92,11 @@ Options - m - false - One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -102,7 +107,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -133,13 +138,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getHostMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs getHostMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index cb33faa0..04b6e080 100644 --- a/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/source/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +`Public Preview: please provide feedback `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -79,11 +84,11 @@ Options - stringArray - true - List that contains the measurements that MongoDB Atlas reports for the associated data series. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -121,13 +126,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --indexName myindex --metrics [metrics] --period PT10H --processId my.host.name.com:27017 + atlas api monitoringAndLogs getIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --indexName myindex --metrics [metrics] --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt index 2854e1c3..33ea96c5 100644 --- a/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs getMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +`Public Preview: please provide feedback `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -67,11 +72,11 @@ Options - stringArray - true - List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -109,13 +114,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs getMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 + atlas api monitoringAndLogs getMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index 59aad384..379ed66d 100644 --- a/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/source/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs listAtlasProcesses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details of all processes for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,15 +106,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns details of all processes for the specified project - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listAtlasProcesses --version 2023-01-01 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Returns details of all processes for the specified project + atlas api monitoringAndLogs listAtlasProcesses --version 2023-01-01 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listDatabases.txt b/source/command/atlas-api-monitoringAndLogs-listDatabases.txt index f9b16c33..8102e10c 100644 --- a/source/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/source/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs listDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. -M0 free clusters, M2, M5, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +M0 free clusters, M2, M5, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listDatabases --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs listDatabases --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index dfbbbce8..db5a49ff 100644 --- a/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/source/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs listDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns measurement details for one disk or partition for the specified host for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements. @@ -55,11 +60,11 @@ Options - - false - help for listDiskMeasurements - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listDiskMeasurements --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --processId mongodb.example.com:27017 + atlas api monitoringAndLogs listDiskMeasurements --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 348a3dba..ea7013c9 100644 --- a/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/source/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -12,9 +12,14 @@ atlas api monitoringAndLogs listDiskPartitions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of disks or partitions for the specified host for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listDiskPartitions --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --processId mongodb.example.com:27017 + atlas api monitoringAndLogs listDiskPartitions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId mongodb.example.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 7da6fcb3..6041dcd3 100644 --- a/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/source/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +`Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics. @@ -73,11 +78,11 @@ Options - stringArray - true - List that contains the measurements that MongoDB Atlas reports for the associated data series. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -115,13 +120,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 + atlas api monitoringAndLogs listIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index e49a3a76..e9571f5e 100644 --- a/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/source/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -12,7 +12,12 @@ atlas api monitoringAndLogs listMetricTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search metric types available for one process in the specified project. +`Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -55,11 +60,11 @@ Options - - false - help for listMetricTypes - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api monitoringAndLogs listMetricTypes --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --processId my.host.name.com:27017 + atlas api monitoringAndLogs listMetricTypes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId my.host.name.com:27017 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-monitoringAndLogs.txt b/source/command/atlas-api-monitoringAndLogs.txt index 6a571957..9cbfd6e6 100644 --- a/source/command/atlas-api-monitoringAndLogs.txt +++ b/source/command/atlas-api-monitoringAndLogs.txt @@ -12,7 +12,14 @@ atlas api monitoringAndLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns database deployment monitoring and logging data. +`Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,20 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback at `_: Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `Public Preview: please provide feedback at `_: Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `Public Preview: please provide feedback at `_: Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `Public Preview: please provide feedback at `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - `Public Preview: please provide feedback at `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `Public Preview: please provide feedback at `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. -* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - `Public Preview: please provide feedback at `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. -* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - `Public Preview: please provide feedback at `_: Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `Public Preview: please provide feedback at `_: Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `Public Preview: please provide feedback at `_: Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `Public Preview: please provide feedback at `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `Public Preview: please provide feedback at `_: Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `Public Preview: please provide feedback `_: Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `Public Preview: please provide feedback `_: Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `Public Preview: please provide feedback `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - `Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `Public Preview: please provide feedback `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - `Public Preview: please provide feedback `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - `Public Preview: please provide feedback `_: Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `Public Preview: please provide feedback `_: Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `Public Preview: please provide feedback `_: Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. .. toctree:: diff --git a/source/command/atlas-api-networkPeering-createPeeringConnection.txt b/source/command/atlas-api-networkPeering-createPeeringConnection.txt index 5c1debcb..6f9f78f7 100644 --- a/source/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -12,9 +12,14 @@ atlas api networkPeering createPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection. @@ -59,18 +64,18 @@ Options - - false - help for createPeeringConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-createPeeringContainer.txt b/source/command/atlas-api-networkPeering-createPeeringContainer.txt index 7fc87d13..7567cd60 100644 --- a/source/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -12,9 +12,14 @@ atlas api networkPeering createPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer. @@ -59,18 +64,18 @@ Options - - false - help for createPeeringContainer - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-deletePeeringConnection.txt b/source/command/atlas-api-networkPeering-deletePeeringConnection.txt index 57382439..57ee8712 100644 --- a/source/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -12,9 +12,14 @@ atlas api networkPeering deletePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection. @@ -55,11 +60,11 @@ Options - - false - help for deletePeeringConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering deletePeeringConnection --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] --pretty false + atlas api networkPeering deletePeeringConnection --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-deletePeeringContainer.txt b/source/command/atlas-api-networkPeering-deletePeeringContainer.txt index 8728d32c..7cc99424 100644 --- a/source/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -12,9 +12,14 @@ atlas api networkPeering deletePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. +`Public Preview: please provide feedback `_: Removes one network peering container in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer. @@ -59,18 +64,18 @@ Options - - false - help for deletePeeringContainer - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering deletePeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api networkPeering deletePeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-disablePeering.txt b/source/command/atlas-api-networkPeering-disablePeering.txt index 8c5f6ae7..c4fc519f 100644 --- a/source/command/atlas-api-networkPeering-disablePeering.txt +++ b/source/command/atlas-api-networkPeering-disablePeering.txt @@ -12,9 +12,14 @@ atlas api networkPeering disablePeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. +`Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering. @@ -59,18 +64,18 @@ Options - - false - help for disablePeering - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-getPeeringConnection.txt b/source/command/atlas-api-networkPeering-getPeeringConnection.txt index 3f521e24..34d0e1f9 100644 --- a/source/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -12,9 +12,14 @@ atlas api networkPeering getPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection. @@ -55,11 +60,11 @@ Options - - false - help for getPeeringConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -70,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering getPeeringConnection --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] --pretty false + atlas api networkPeering getPeeringConnection --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --peerId [peerId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-getPeeringContainer.txt b/source/command/atlas-api-networkPeering-getPeeringContainer.txt index 4f198706..be545b86 100644 --- a/source/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -12,9 +12,14 @@ atlas api networkPeering getPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer. @@ -59,18 +64,18 @@ Options - - false - help for getPeeringContainer - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering getPeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api networkPeering getPeeringContainer --version 2023-01-01 --containerId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-listPeeringConnections.txt b/source/command/atlas-api-networkPeering-listPeeringConnections.txt index 4d6e0837..1ef7e84d 100644 --- a/source/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/source/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -12,9 +12,14 @@ atlas api networkPeering listPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --providerName - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering listPeeringConnections --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api networkPeering listPeeringConnections --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 1fde76c9..b5468370 100644 --- a/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/source/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -12,9 +12,14 @@ atlas api networkPeering listPeeringContainerByCloudProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project for the specified cloud provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --providerName - string - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering listPeeringContainerByCloudProvider --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --providerName [providerName] + atlas api networkPeering listPeeringContainerByCloudProvider --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --providerName [providerName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-listPeeringContainers.txt b/source/command/atlas-api-networkPeering-listPeeringContainers.txt index d04c5554..28641366 100644 --- a/source/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/source/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -12,9 +12,14 @@ atlas api networkPeering listPeeringContainers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering listPeeringContainers --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api networkPeering listPeeringContainers --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering-updatePeeringConnection.txt b/source/command/atlas-api-networkPeering-updatePeeringConnection.txt index 0db37a00..6d79651b 100644 --- a/source/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/source/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -12,9 +12,14 @@ atlas api networkPeering updatePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. +`Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection. @@ -59,11 +64,11 @@ Options - - false - help for updatePeeringConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -74,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-updatePeeringContainer.txt b/source/command/atlas-api-networkPeering-updatePeeringContainer.txt index 75d92063..2be16fe4 100644 --- a/source/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/source/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -12,9 +12,14 @@ atlas api networkPeering updatePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the network details and labels of one specified network peering container in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer. @@ -63,18 +68,18 @@ Options - - false - help for updatePeeringContainer - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 923dd610..7bafed75 100644 --- a/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/source/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -12,9 +12,14 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies if someone set the specified project to Connect via Peering Only mode. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject. @@ -55,18 +60,18 @@ Options - - false - help for verifyConnectViaPeeringOnlyModeForOneProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-networkPeering.txt b/source/command/atlas-api-networkPeering.txt index 2654e29e..b7878bb5 100644 --- a/source/command/atlas-api-networkPeering.txt +++ b/source/command/atlas-api-networkPeering.txt @@ -12,7 +12,12 @@ atlas api networkPeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network peering containers and peering connections. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - `Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - `Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - `Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - `Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - `Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - `Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `Public Preview: please provide feedback at `_: Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `Public Preview: please provide feedback at `_: Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - `Public Preview: please provide feedback `_: Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `Public Preview: please provide feedback `_: Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `Public Preview: please provide feedback `_: Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - `Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - `Public Preview: please provide feedback `_: Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - `Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - `Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - `Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `Public Preview: please provide feedback `_: Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `Public Preview: please provide feedback `_: Verifies if someone set the specified project to Connect via Peering Only mode. .. toctree:: diff --git a/source/command/atlas-api-onlineArchive-createOnlineArchive.txt b/source/command/atlas-api-onlineArchive-createOnlineArchive.txt index 486412d8..ecb1f517 100644 --- a/source/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -12,9 +12,14 @@ atlas api onlineArchive createOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one online archive. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive. @@ -63,18 +68,18 @@ Options - - false - help for createOnlineArchive - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index debd95db..a7d65632 100644 --- a/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -12,9 +12,14 @@ atlas api onlineArchive deleteOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one online archive. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive. @@ -63,18 +68,18 @@ Options - - false - help for deleteOnlineArchive - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api onlineArchive deleteOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api onlineArchive deleteOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 33da882b..e957e309 100644 --- a/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/source/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -12,9 +12,14 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. +`Public Preview: please provide feedback `_: 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". +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs. @@ -67,11 +72,11 @@ Options - - false - help for downloadOnlineArchiveQueryLogs - * - --output + * - -o, --output - string - false - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09 + atlas api onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-getOnlineArchive.txt b/source/command/atlas-api-onlineArchive-getOnlineArchive.txt index 53544785..f3f7c23d 100644 --- a/source/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -12,9 +12,14 @@ atlas api onlineArchive getOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one online archive for one cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive. @@ -63,18 +68,18 @@ Options - - false - help for getOnlineArchive - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api onlineArchive getOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api onlineArchive getOnlineArchive --version 2023-01-01 --archiveId [archiveId] --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-listOnlineArchives.txt b/source/command/atlas-api-onlineArchive-listOnlineArchives.txt index 486285c0..99dbcaf7 100644 --- a/source/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/source/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -12,9 +12,14 @@ atlas api onlineArchive listOnlineArchives :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details of all online archives. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api onlineArchive listOnlineArchives --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api onlineArchive listOnlineArchives --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt index abe2700b..6751ffe7 100644 --- a/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/source/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -12,9 +12,14 @@ atlas api onlineArchive updateOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive. @@ -67,18 +72,18 @@ Options - - false - help for updateOnlineArchive - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-onlineArchive.txt b/source/command/atlas-api-onlineArchive.txt index 2898a139..c739fb42 100644 --- a/source/command/atlas-api-onlineArchive.txt +++ b/source/command/atlas-api-onlineArchive.txt @@ -12,7 +12,14 @@ atlas api onlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, or removes an online archive. +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback at `_: Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback at `_: Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `Public Preview: please provide feedback at `_: Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback at `_: Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback `_: Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback `_: Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback `_: Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `Public Preview: please provide feedback `_: Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback `_: Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive. .. toctree:: diff --git a/source/command/atlas-api-organizations-createOrganization.txt b/source/command/atlas-api-organizations-createOrganization.txt index 625d657d..e1c0df39 100644 --- a/source/command/atlas-api-organizations-createOrganization.txt +++ b/source/command/atlas-api-organizations-createOrganization.txt @@ -12,9 +12,14 @@ atlas api organizations createOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +`Public Preview: please provide feedback `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. -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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization. @@ -53,18 +58,18 @@ Options - - false - help for createOrganization - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-createOrganizationInvitation.txt b/source/command/atlas-api-organizations-createOrganizationInvitation.txt index 6b26ca76..ed8e5b92 100644 --- a/source/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -12,9 +12,14 @@ atlas api organizations createOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user. @@ -60,18 +65,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-deleteOrganization.txt b/source/command/atlas-api-organizations-deleteOrganization.txt index 86c5567b..589a24f7 100644 --- a/source/command/atlas-api-organizations-deleteOrganization.txt +++ b/source/command/atlas-api-organizations-deleteOrganization.txt @@ -12,7 +12,12 @@ atlas api organizations deleteOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one specified organization. +`Public Preview: please provide feedback `_: Removes one specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud imposes the following limits on this resource: @@ -22,7 +27,7 @@ Organizations with active projects cannot be removed. All projects in the organization must be removed before you can remove the organization. -To use this resource, the requesting API Key must have the Organization Owner role. +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization. @@ -61,11 +66,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations deleteOrganization --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 + atlas api organizations deleteOrganization --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt index 0968741c..7a903076 100644 --- a/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -12,9 +12,14 @@ atlas api organizations deleteOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Remove One MongoDB Cloud User From One Organization to remove a pending user. @@ -60,18 +65,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -94,13 +99,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations deleteOrganizationInvitation --version 2023-01-01 --envelope false --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations deleteOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-getOrganization.txt b/source/command/atlas-api-organizations-getOrganization.txt index 27b3639e..0518154c 100644 --- a/source/command/atlas-api-organizations-getOrganization.txt +++ b/source/command/atlas-api-organizations-getOrganization.txt @@ -12,9 +12,14 @@ atlas api organizations getOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization to which the requesting API key has access. +`Public Preview: please provide feedback `_: Returns one organization to which the requesting Service Account or API Key has access. -To use this resource, the requesting API Key must have the Organization Member role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations getOrganization --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations getOrganization --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-getOrganizationInvitation.txt b/source/command/atlas-api-organizations-getOrganizationInvitation.txt index 964a9eda..2ab06106 100644 --- a/source/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -12,9 +12,14 @@ atlas api organizations getOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Return One MongoDB Cloud User in One Organization to return a pending user. @@ -60,11 +65,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -90,13 +95,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations getOrganizationInvitation --version 2023-01-01 --envelope false --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 + atlas api organizations getOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-getOrganizationSettings.txt b/source/command/atlas-api-organizations-getOrganizationSettings.txt index 422cd524..5506cc7d 100644 --- a/source/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/source/command/atlas-api-organizations-getOrganizationSettings.txt @@ -12,9 +12,14 @@ atlas api organizations getOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. +`Public Preview: please provide feedback `_: Returns details about the specified organization's settings. -To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations getOrganizationSettings --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations getOrganizationSettings --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-listOrganizationInvitations.txt b/source/command/atlas-api-organizations-listOrganizationInvitations.txt index a96192e5..fa0527d5 100644 --- a/source/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/source/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -12,9 +12,14 @@ atlas api organizations listOrganizationInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. -To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: Invitation management APIs are deprecated. Use Return All MongoDB Cloud Users in One Organization and filter by orgMembershipStatus to return all pending users. @@ -56,18 +61,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - false @@ -94,13 +99,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations listOrganizationInvitations --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api organizations listOrganizationInvitations --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-listOrganizationProjects.txt b/source/command/atlas-api-organizations-listOrganizationProjects.txt index 1a4da7f4..185a627b 100644 --- a/source/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/source/command/atlas-api-organizations-listOrganizationProjects.txt @@ -12,7 +12,12 @@ atlas api organizations listOrganizationProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns multiple projects in the specified organization. +`Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Each organization can have multiple projects. Use projects to: @@ -31,7 +36,7 @@ Create different alert settings. -To use this resource, the requesting API Key must have the Organization Member role. +To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects. @@ -82,11 +87,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -97,7 +102,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -120,13 +125,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api organizations listOrganizationProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api organizations listOrganizationProjects --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-organizations-listOrganizations.txt b/source/command/atlas-api-organizations-listOrganizations.txt index 83fe2ceb..a8ba0228 100644 --- a/source/command/atlas-api-organizations-listOrganizations.txt +++ b/source/command/atlas-api-organizations-listOrganizations.txt @@ -12,9 +12,14 @@ atlas api organizations listOrganizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organizations to which the requesting API Key has access. +`Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has access. -To use this resource, the requesting API Key must have the Organization Member role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations. @@ -61,11 +66,11 @@ Options - string - false - Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -76,7 +81,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -98,14 +103,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api organizations listOrganizations --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-organizations-updateOrganization.txt b/source/command/atlas-api-organizations-updateOrganization.txt index b373ad69..c70cfe7d 100644 --- a/source/command/atlas-api-organizations-updateOrganization.txt +++ b/source/command/atlas-api-organizations-updateOrganization.txt @@ -12,9 +12,14 @@ atlas api organizations updateOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one organization. +`Public Preview: please provide feedback `_: Updates one organization. -To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-updateOrganizationInvitation.txt b/source/command/atlas-api-organizations-updateOrganizationInvitation.txt index 4dae35d9..283d76c7 100644 --- a/source/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/source/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Organization Owner role. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 2ad58f8b..0476cc3f 100644 --- a/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/source/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -12,7 +12,12 @@ atlas api organizations updateOrganizationInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -61,18 +66,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations-updateOrganizationRoles.txt b/source/command/atlas-api-organizations-updateOrganizationRoles.txt index 88afb48c..fa3bf257 100644 --- a/source/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/source/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -12,9 +12,14 @@ atlas api organizations updateOrganizationRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-organizations-updateOrganizationSettings.txt b/source/command/atlas-api-organizations-updateOrganizationSettings.txt index 65d220f6..d11e5e62 100644 --- a/source/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/source/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -12,9 +12,14 @@ atlas api organizations updateOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the organization's settings. +`Public Preview: please provide feedback `_: Updates the organization's settings. -To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-organizations.txt b/source/command/atlas-api-organizations.txt index 1c3864d4..426d78e4 100644 --- a/source/command/atlas-api-organizations.txt +++ b/source/command/atlas-api-organizations.txt @@ -12,7 +12,14 @@ atlas api organizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits organizational units in MongoDB Cloud. +`Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,21 +56,21 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. -* :ref:`atlas-api-organizations-createOrganizationInvitation` - `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback at `_: Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - `Public Preview: please provide feedback at `_: Returns one organization to which the requesting API key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - `Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - `Public Preview: please provide feedback at `_: Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback at `_: Returns all organizations to which the requesting API Key has access. -* :ref:`atlas-api-organizations-updateOrganization` - `Public Preview: please provide feedback at `_: Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - `Public Preview: please provide feedback at `_: Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. +* :ref:`atlas-api-organizations-createOrganizationInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback `_: Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrganization` - `Public Preview: please provide feedback `_: Returns one organization to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - `Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - `Public Preview: please provide feedback `_: Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - `Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - `Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-updateOrganization` - `Public Preview: please provide feedback `_: Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - `Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - `Public Preview: please provide feedback `_: Updates the organization's settings. .. toctree:: diff --git a/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index cf00ef2e..806b6cd3 100644 --- a/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/source/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor disableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding. @@ -55,18 +60,18 @@ Options - - false - help for disableSlowOperationThresholding - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor disableSlowOperationThresholding --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor disableSlowOperationThresholding --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 22b7e990..fe4f2f14 100644 --- a/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/source/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor enableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding. @@ -55,18 +60,18 @@ Options - - false - help for enableSlowOperationThresholding - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor enableSlowOperationThresholding --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor enableSlowOperationThresholding --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 7f756cd8..0401233f 100644 --- a/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/source/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor getManagedSlowMs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get whether the Managed Slow MS feature is enabled. +`Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs. @@ -53,18 +58,18 @@ Options - - false - help for getManagedSlowMs - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor getManagedSlowMs --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor getManagedSlowMs --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index bdb939b9..243973bc 100644 --- a/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/source/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor getServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get whether the Serverless Auto Indexing feature is enabled. +`Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint returns a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. @@ -59,18 +64,18 @@ Options - - false - help for getServerlessAutoIndexing - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor getServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor getServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 2000dbdb..e28c1933 100644 --- a/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/source/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor listClusterSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes. @@ -58,12 +63,12 @@ Options * - --namespaces - . - false - - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. - * - --output + - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -107,9 +112,7 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: diff --git a/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt index 8d083ed9..b5c6f042 100644 --- a/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/source/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor listDropIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes. @@ -55,11 +60,11 @@ Options - - false - help for listDropIndexes - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,9 +90,7 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: diff --git a/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index 70b85b06..8ae098b1 100644 --- a/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/source/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor listSchemaAdvice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice. @@ -55,11 +60,11 @@ Options - - false - help for listSchemaAdvice - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,9 +90,7 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: diff --git a/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt index f6fca426..266699b2 100644 --- a/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/source/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor listSlowQueries :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +`Public Preview: please provide feedback `_: 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 any Project Data Access role or the Project Observability Viewer role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries. @@ -62,6 +67,18 @@ Options - - false - help for listSlowQueries + * - --includeMetrics + - + - false + - Whether or not to include metrics extracted from the slow query log as separate fields. + * - --includeOpType + - + - false + - Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field. + * - --includeReplicaState + - + - false + - Whether or not to include the replica state of the host when the slow query log was generated as a separate field. * - --nLogs - int - false @@ -69,19 +86,19 @@ Options * - --namespaces - . - false - - Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. - * - --output + - Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -115,13 +132,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor listSlowQueries --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId [processId] + atlas api performanceAdvisor listSlowQueries --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index 03708bb5..e1a6dcfb 100644 --- a/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/source/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor listSlowQueryNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces. @@ -62,18 +67,18 @@ Options - - false - help for listSlowQueryNamespaces - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -107,13 +112,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor listSlowQueryNamespaces --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processId [processId] + atlas api performanceAdvisor listSlowQueryNamespaces --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index a56189a2..2fb00991 100644 --- a/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/source/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -12,9 +12,14 @@ atlas api performanceAdvisor listSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes. @@ -81,12 +86,12 @@ Options * - --namespaces - . - false - - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. - * - --output + - Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: ``.``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -97,7 +102,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processId - mongod - true @@ -131,13 +136,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --processId [processId] + atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index a6e39d7a..d52caa0c 100644 --- a/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/source/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor setServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Set whether the Serverless Auto Indexing feature is enabled. +`Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. @@ -59,18 +64,18 @@ Options - - false - help for setServerlessAutoIndexing - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api performanceAdvisor setServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --enable [enable] --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api performanceAdvisor setServerlessAutoIndexing --version 2023-01-01 --clusterName [clusterName] --enable [enable] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-performanceAdvisor.txt b/source/command/atlas-api-performanceAdvisor.txt index 64c082a9..93dc2d2a 100644 --- a/source/command/atlas-api-performanceAdvisor.txt +++ b/source/command/atlas-api-performanceAdvisor.txt @@ -12,7 +12,12 @@ atlas api performanceAdvisor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns suggested indexes and slow query data for a database deployment. +`Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `Public Preview: please provide feedback at `_: Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `Public Preview: please provide feedback at `_: Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `Public Preview: please provide feedback at `_: Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `Public Preview: please provide feedback `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `Public Preview: please provide feedback `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. .. toctree:: diff --git a/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 6928a2d9..ec1fc353 100644 --- a/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/source/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices createPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint. @@ -67,18 +72,18 @@ Options - - false - help for createPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index b0df7056..e13a2cc7 100644 --- a/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/source/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices createPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService. @@ -59,18 +64,18 @@ Options - - false - help for createPrivateEndpointService - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index bc80c3c6..c9e842af 100644 --- a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices deletePrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint. @@ -67,18 +72,18 @@ Options - - false - help for deletePrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api privateEndpointServices deletePrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices deletePrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index cee726ba..f92f9e9a 100644 --- a/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/source/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices deletePrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint service from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService. @@ -63,18 +68,18 @@ Options - - false - help for deletePrivateEndpointService - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api privateEndpointServices deletePrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices deletePrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 3a567553..86ef6314 100644 --- a/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/source/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices getPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint. @@ -67,18 +72,18 @@ Options - - false - help for getPrivateEndpoint - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api privateEndpointServices getPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices getPrivateEndpoint --version 2023-01-01 --cloudProvider [cloudProvider] --endpointId [endpointId] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index bd278302..3caa103b 100644 --- a/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/source/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices getPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService. @@ -63,18 +68,18 @@ Options - - false - help for getPrivateEndpointService - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api privateEndpointServices getPrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices getPrivateEndpointService --version 2023-01-01 --cloudProvider [cloudProvider] --endpointServiceId [endpointServiceId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 44b40db9..8a0aeea8 100644 --- a/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/source/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting. @@ -55,18 +60,18 @@ Options - - false - help for getRegionalizedPrivateEndpointSetting - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index cd38c70f..18c0462e 100644 --- a/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/source/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices listPrivateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices. @@ -59,18 +64,18 @@ Options - - false - help for listPrivateEndpointServices - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api privateEndpointServices listPrivateEndpointServices --version 2023-01-01 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api privateEndpointServices listPrivateEndpointServices --version 2023-01-01 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index b43326c3..2e9131b3 100644 --- a/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/source/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -12,9 +12,14 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting. @@ -59,18 +64,18 @@ Options - - false - help for toggleRegionalizedPrivateEndpointSetting - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-privateEndpointServices.txt b/source/command/atlas-api-privateEndpointServices.txt index 89bf2afe..12389df6 100644 --- a/source/command/atlas-api-privateEndpointServices.txt +++ b/source/command/atlas-api-privateEndpointServices.txt @@ -12,7 +12,14 @@ atlas api privateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoint services. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,15 +56,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `Public Preview: please provide feedback at `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - `Public Preview: please provide feedback at `_: Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback at `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback at `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `Public Preview: please provide feedback `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - `Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `Public Preview: please provide feedback `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `Public Preview: please provide feedback `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. .. toctree:: diff --git a/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index 697ef499..fb0bdcdc 100644 --- a/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys addProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey. @@ -63,18 +68,18 @@ Options - - false - help for addProjectApiKey - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-createApiKey.txt b/source/command/atlas-api-programmaticApiKeys-createApiKey.txt index 8f6782e2..cc8d6907 100644 --- a/source/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys createApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one API key for the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index b01a9730..b8c16eca 100644 --- a/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/source/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys createApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList. @@ -69,11 +74,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -84,7 +89,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 81d4f685..df00f900 100644 --- a/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys createProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey. @@ -59,18 +64,18 @@ Options - - false - help for createProjectApiKey - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index a1716694..56718bd6 100644 --- a/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys deleteApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys deleteApiKey --version 2023-01-01 --apiUserId [apiUserId] --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys deleteApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 64df0e37..24a229d1 100644 --- a/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/source/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry. @@ -61,18 +66,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys deleteApiKeyAccessListEntry --version 2023-01-01 --apiUserId [apiUserId] --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys deleteApiKeyAccessListEntry --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-getApiKey.txt b/source/command/atlas-api-programmaticApiKeys-getApiKey.txt index 0355887f..a2b431bf 100644 --- a/source/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys getApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization API key. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys getApiKey --version 2023-01-01 --apiUserId [apiUserId] --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys getApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index cd1c50a8..60b286c6 100644 --- a/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/source/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys getApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList. @@ -61,18 +66,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false + atlas api programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 8f1335e3..c58ffe5a 100644 --- a/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/source/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries. @@ -65,11 +70,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -80,7 +85,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -103,13 +108,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys listApiKeyAccessListsEntries --version 2023-01-01 --apiUserId [apiUserId] --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api programmaticApiKeys listApiKeyAccessListsEntries --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt index 3b4961ec..e7199993 100644 --- a/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/source/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys listApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys. @@ -61,11 +66,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -76,7 +81,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys listApiKeys --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api programmaticApiKeys listApiKeys --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index a21ed3a5..bad62185 100644 --- a/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/source/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys listProjectApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys listProjectApiKeys --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api programmaticApiKeys listProjectApiKeys --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index ffb1a898..3a0e0f06 100644 --- a/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -12,9 +12,14 @@ atlas api programmaticApiKeys removeProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. +`Public Preview: please provide feedback `_: Removes one organization API key from the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey. @@ -59,18 +64,18 @@ Options - - false - help for removeProjectApiKey - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api programmaticApiKeys removeProjectApiKey --version 2023-01-01 --apiUserId [apiUserId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api programmaticApiKeys removeProjectApiKey --version 2023-01-01 --apiUserId [apiUserId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt index c6dd5d5c..693ddcce 100644 --- a/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/source/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys updateApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one organization API key in the specified organization. +`Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -61,18 +66,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 429276c9..ab6b34af 100644 --- a/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/source/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys updateApiKeyRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the organization API key that you specify for the project that you specify. +`Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -71,11 +76,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-programmaticApiKeys.txt b/source/command/atlas-api-programmaticApiKeys.txt index 4fccf957..e6e1889c 100644 --- a/source/command/atlas-api-programmaticApiKeys.txt +++ b/source/command/atlas-api-programmaticApiKeys.txt @@ -12,7 +12,12 @@ atlas api programmaticApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project. @@ -51,20 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `Public Preview: please provide feedback at `_: Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `Public Preview: please provide feedback at `_: Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `Public Preview: please provide feedback at `_: Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `Public Preview: please provide feedback `_: Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `Public Preview: please provide feedback `_: Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `Public Preview: please provide feedback `_: Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `Public Preview: please provide feedback `_: Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `Public Preview: please provide feedback `_: Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `Public Preview: please provide feedback `_: Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. .. toctree:: diff --git a/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index a9248946..14873209 100644 --- a/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/source/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -12,9 +12,14 @@ atlas api projectIpAccessList createProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList. @@ -67,11 +72,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +87,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,14 +110,13 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Adds multiple access list entries to the specified project +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Adds multiple access list entries to the specified project [ { "cidrBlock": "192.168.1.0/24", @@ -125,11 +129,12 @@ Create the file below and save it as `payload.json` ] .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api projectIpAccessList createProjectIpAccessList --version 2023-01-01 --file payload.json --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Adds multiple access list entries to the specified project + atlas api projectIpAccessList createProjectIpAccessList --version 2023-01-01 --file payload.json --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index 35b5acbe..57170c7f 100644 --- a/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/source/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -12,9 +12,14 @@ atlas api projectIpAccessList deleteProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList. @@ -63,18 +68,18 @@ Options - - false - help for deleteProjectIpAccessList - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,15 +102,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Removes one access list entry from the specified project's IP access list - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList deleteProjectIpAccessList --version 2023-01-01 --entryValue 10.0.0.0/16 --envelope false --groupId [your-project-id] --pretty false + # Removes one access list entry from the specified project's IP access list + atlas api projectIpAccessList deleteProjectIpAccessList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 32301494..b8f758cb 100644 --- a/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/source/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList getProjectIpAccessListStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of one project IP access list entry. +`Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -59,18 +64,18 @@ Options - - false - help for getProjectIpAccessListStatus - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,15 +98,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns the status of 10.0.0.0/16 - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList getProjectIpAccessListStatus --version 2023-01-01 --entryValue 10.0.0.0/16 --envelope false --groupId [your-project-id] --pretty false + # Returns the status of 10.0.0.0/16 + atlas api projectIpAccessList getProjectIpAccessListStatus --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt index 6e4a41ec..6f171aec 100644 --- a/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/source/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -12,9 +12,14 @@ atlas api projectIpAccessList getProjectIpList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList. @@ -59,18 +64,18 @@ Options - - false - help for getProjectIpList - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,15 +98,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns one access list entry from the specified project's IP access list: 10.0.0.0/16 - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --envelope false --groupId [your-project-id] --pretty false + # Returns one access list entry from the specified project's IP access list: 10.0.0.0/16 + atlas api projectIpAccessList getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index 8dd8ba77..b607f417 100644 --- a/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/source/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -12,9 +12,14 @@ atlas api projectIpAccessList listProjectIpAccessLists :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,15 +106,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Returns all access list entries from the specified project's IP access list. - -Run the command below. +-------- .. code-block:: - atlas api projectIpAccessList listProjectIpAccessLists --version 2023-01-01 --envelope false --groupId [your-project-id] --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Returns all access list entries from the specified project's IP access list. + atlas api projectIpAccessList listProjectIpAccessLists --version 2023-01-01 --groupId [your-project-id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projectIpAccessList.txt b/source/command/atlas-api-projectIpAccessList.txt index 7ed6dd81..3dbbea95 100644 --- a/source/command/atlas-api-projectIpAccessList.txt +++ b/source/command/atlas-api-projectIpAccessList.txt @@ -12,7 +12,12 @@ atlas api projectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `Public Preview: please provide feedback at `_: Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `Public Preview: please provide feedback `_: Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `Public Preview: please provide feedback `_: Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `Public Preview: please provide feedback `_: Returns all access list entries from the specified project's IP access list. .. toctree:: diff --git a/source/command/atlas-api-projects-addUserToProject.txt b/source/command/atlas-api-projects-addUserToProject.txt index 3940c609..a9d8f95c 100644 --- a/source/command/atlas-api-projects-addUserToProject.txt +++ b/source/command/atlas-api-projects-addUserToProject.txt @@ -12,9 +12,14 @@ atlas api projects addUserToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject. @@ -59,18 +64,18 @@ Options - - false - help for addUserToProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-createProject.txt b/source/command/atlas-api-projects-createProject.txt index 7b10a198..6927e64f 100644 --- a/source/command/atlas-api-projects-createProject.txt +++ b/source/command/atlas-api-projects-createProject.txt @@ -12,9 +12,14 @@ atlas api projects createProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject. @@ -53,18 +58,18 @@ Options - - false - help for createProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --projectOwnerId - string - false @@ -91,14 +96,13 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Creates a new project named "MongoTube" with an environment tag set to "e2e" +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Creates a new project named "MongoTube" with an environment tag set to "e2e" { "name": "MongoTube", "orgId": "67b715468c10250b968dcb84", @@ -111,11 +115,12 @@ Create the file below and save it as `payload.json` } .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api projects createProject --version 2023-01-01 --file payload.json --envelope false --pretty false + # Creates a new project named "MongoTube" with an environment tag set to "e2e" + atlas api projects createProject --version 2023-01-01 --file payload.json .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-createProjectInvitation.txt b/source/command/atlas-api-projects-createProjectInvitation.txt index dd2d0518..5ea321ee 100644 --- a/source/command/atlas-api-projects-createProjectInvitation.txt +++ b/source/command/atlas-api-projects-createProjectInvitation.txt @@ -12,9 +12,14 @@ atlas api projects createProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation. @@ -59,18 +64,18 @@ Options - - false - help for createProjectInvitation - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-deleteProject.txt b/source/command/atlas-api-projects-deleteProject.txt index 6accf1af..b39c5240 100644 --- a/source/command/atlas-api-projects-deleteProject.txt +++ b/source/command/atlas-api-projects-deleteProject.txt @@ -12,9 +12,14 @@ atlas api projects deleteProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject. @@ -55,18 +60,18 @@ Options - - false - help for deleteProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,15 +94,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Deletes an existing project - -Run the command below. +-------- .. code-block:: - atlas api projects deleteProject --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Deletes an existing project + atlas api projects deleteProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-deleteProjectInvitation.txt b/source/command/atlas-api-projects-deleteProjectInvitation.txt index 55d8dbf9..7224c04b 100644 --- a/source/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/source/command/atlas-api-projects-deleteProjectInvitation.txt @@ -12,9 +12,14 @@ atlas api projects deleteProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation. @@ -59,11 +64,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the invitation. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects deleteProjectInvitation --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] + atlas api projects deleteProjectInvitation --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-deleteProjectLimit.txt b/source/command/atlas-api-projects-deleteProjectLimit.txt index c449f154..f1be0de7 100644 --- a/source/command/atlas-api-projects-deleteProjectLimit.txt +++ b/source/command/atlas-api-projects-deleteProjectLimit.txt @@ -12,9 +12,14 @@ atlas api projects deleteProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified project limit. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit. @@ -76,18 +81,18 @@ Options | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -110,13 +115,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects deleteProjectLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --pretty false + atlas api projects deleteProjectLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProject.txt b/source/command/atlas-api-projects-getProject.txt index df035cd9..bd922351 100644 --- a/source/command/atlas-api-projects-getProject.txt +++ b/source/command/atlas-api-projects-getProject.txt @@ -12,9 +12,14 @@ atlas api projects getProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject. @@ -55,18 +60,18 @@ Options - - false - help for getProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,15 +94,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Get a project using a project id - -Run the command below. +-------- .. code-block:: - atlas api projects getProject --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Get a project using a project id + atlas api projects getProject --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectByName.txt b/source/command/atlas-api-projects-getProjectByName.txt index ec1a9afe..ff0befed 100644 --- a/source/command/atlas-api-projects-getProjectByName.txt +++ b/source/command/atlas-api-projects-getProjectByName.txt @@ -12,7 +12,12 @@ atlas api projects getProjectByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the project identified by its name. +`Public Preview: please provide feedback `_: Returns details about the project identified by its name. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -53,18 +58,18 @@ Options - - false - help for getProjectByName - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -86,14 +91,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api projects getProjectByName --version 2023-01-01 --envelope false --groupName [groupName] --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-projects-getProjectInvitation.txt b/source/command/atlas-api-projects-getProjectInvitation.txt index 48b46cdc..bd40a32e 100644 --- a/source/command/atlas-api-projects-getProjectInvitation.txt +++ b/source/command/atlas-api-projects-getProjectInvitation.txt @@ -12,9 +12,14 @@ atlas api projects getProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation. @@ -59,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the invitation. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects getProjectInvitation --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] --pretty false + atlas api projects getProjectInvitation --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --invitationId [invitationId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectLimit.txt b/source/command/atlas-api-projects-getProjectLimit.txt index 8a1aea9a..c2575417 100644 --- a/source/command/atlas-api-projects-getProjectLimit.txt +++ b/source/command/atlas-api-projects-getProjectLimit.txt @@ -12,9 +12,14 @@ atlas api projects getProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified limit for the specified project. +`Public Preview: please provide feedback `_: Returns the specified limit for the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit. @@ -76,18 +81,18 @@ Options | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -110,13 +115,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects getProjectLimit --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] --pretty false + atlas api projects getProjectLimit --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --limitName [limitName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectLtsVersions.txt b/source/command/atlas-api-projects-getProjectLtsVersions.txt index 7a4a1937..ecdbb309 100644 --- a/source/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/source/command/atlas-api-projects-getProjectLtsVersions.txt @@ -12,7 +12,12 @@ atlas api projects getProjectLtsVersions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +`Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions. @@ -69,11 +74,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -84,7 +89,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -107,13 +112,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects getProjectLtsVersions --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceSize M10 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api projects getProjectLtsVersions --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --instanceSize M10 --itemsPerPage 100 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-getProjectSettings.txt b/source/command/atlas-api-projects-getProjectSettings.txt index 5d9e3dd2..4e965de4 100644 --- a/source/command/atlas-api-projects-getProjectSettings.txt +++ b/source/command/atlas-api-projects-getProjectSettings.txt @@ -12,9 +12,14 @@ atlas api projects getProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified project's settings. +`Public Preview: please provide feedback `_: Returns details about the specified project's settings. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings. @@ -55,18 +60,18 @@ Options - - false - help for getProjectSettings - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects getProjectSettings --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects getProjectSettings --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-listProjectInvitations.txt b/source/command/atlas-api-projects-listProjectInvitations.txt index 15b14a52..1e0ba19d 100644 --- a/source/command/atlas-api-projects-listProjectInvitations.txt +++ b/source/command/atlas-api-projects-listProjectInvitations.txt @@ -12,9 +12,14 @@ atlas api projects listProjectInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations. @@ -55,18 +60,18 @@ Options - - false - help for listProjectInvitations - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects listProjectInvitations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects listProjectInvitations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-listProjectLimits.txt b/source/command/atlas-api-projects-listProjectLimits.txt index c9424338..6dbec841 100644 --- a/source/command/atlas-api-projects-listProjectLimits.txt +++ b/source/command/atlas-api-projects-listProjectLimits.txt @@ -12,9 +12,14 @@ atlas api projects listProjectLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all the limits for the specified project. +`Public Preview: please provide feedback `_: Returns all the limits for the specified project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits. @@ -55,18 +60,18 @@ Options - - false - help for listProjectLimits - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects listProjectLimits --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects listProjectLimits --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-listProjects.txt b/source/command/atlas-api-projects-listProjects.txt index 3de60f74..f37dd3c1 100644 --- a/source/command/atlas-api-projects-listProjects.txt +++ b/source/command/atlas-api-projects-listProjects.txt @@ -12,9 +12,14 @@ atlas api projects listProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all projects. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects. @@ -57,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,15 +100,12 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Get a list of all projects inside of the organisation - -Run the command below. +-------- .. code-block:: - atlas api projects listProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + # Get a list of all projects inside of the organisation + atlas api projects listProjects --version 2023-01-01 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 4dac1f34..305d0a15 100644 --- a/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/source/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -12,9 +12,14 @@ atlas api projects migrateProjectToAnotherOrg :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg. @@ -59,11 +64,11 @@ Options - - false - help for migrateProjectToAnotherOrg - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-projects-returnAllIpAddresses.txt b/source/command/atlas-api-projects-returnAllIpAddresses.txt index 00fbfd37..57fd4d2a 100644 --- a/source/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/source/command/atlas-api-projects-returnAllIpAddresses.txt @@ -12,9 +12,14 @@ atlas api projects returnAllIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all IP addresses for this project. +`Public Preview: please provide feedback `_: Returns all IP addresses for this project. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses. @@ -55,18 +60,18 @@ Options - - false - help for returnAllIpAddresses - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api projects returnAllIpAddresses --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api projects returnAllIpAddresses --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-setProjectLimit.txt b/source/command/atlas-api-projects-setProjectLimit.txt index db1875c4..c7329dcd 100644 --- a/source/command/atlas-api-projects-setProjectLimit.txt +++ b/source/command/atlas-api-projects-setProjectLimit.txt @@ -12,9 +12,14 @@ atlas api projects setProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Sets the specified project limit. +`Public Preview: please provide feedback `_: Sets the specified project limit. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or 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. @@ -83,18 +88,18 @@ Options | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27| | atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 | - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-updateProject.txt b/source/command/atlas-api-projects-updateProject.txt index 96fed1dc..6d7f4947 100644 --- a/source/command/atlas-api-projects-updateProject.txt +++ b/source/command/atlas-api-projects-updateProject.txt @@ -12,9 +12,14 @@ atlas api projects updateProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject. @@ -59,18 +64,18 @@ Options - - false - help for updateProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,14 +98,13 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - - Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" +-------- -Create the file below and save it as `payload.json` +Create the file below and save it as ``payload.json`` .. code-block:: + # Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" { "name": "MongoTube - Production", "tags": [ @@ -112,11 +116,12 @@ Create the file below and save it as `payload.json` } .. Code end marker, please don't delete this comment -After creating `payload.json`, run the command below in the same directory. +After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api projects updateProject --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" + atlas api projects updateProject --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-projects-updateProjectInvitation.txt b/source/command/atlas-api-projects-updateProjectInvitation.txt index 72117530..0331b8f6 100644 --- a/source/command/atlas-api-projects-updateProjectInvitation.txt +++ b/source/command/atlas-api-projects-updateProjectInvitation.txt @@ -12,7 +12,12 @@ atlas api projects updateProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Project Owner role. @@ -59,18 +64,18 @@ Options - - false - help for updateProjectInvitation - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects-updateProjectInvitationById.txt b/source/command/atlas-api-projects-updateProjectInvitationById.txt index 6e44112d..fbb0a468 100644 --- a/source/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/source/command/atlas-api-projects-updateProjectInvitationById.txt @@ -12,7 +12,12 @@ atlas api projects updateProjectInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -63,11 +68,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the invitation. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-projects-updateProjectRoles.txt b/source/command/atlas-api-projects-updateProjectRoles.txt index 41f86c05..775488b1 100644 --- a/source/command/atlas-api-projects-updateProjectRoles.txt +++ b/source/command/atlas-api-projects-updateProjectRoles.txt @@ -12,9 +12,14 @@ atlas api projects updateProjectRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles. @@ -59,18 +64,18 @@ Options - - false - help for updateProjectRoles - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --userId - string - true diff --git a/source/command/atlas-api-projects-updateProjectSettings.txt b/source/command/atlas-api-projects-updateProjectSettings.txt index 8341f6c9..294ca53b 100644 --- a/source/command/atlas-api-projects-updateProjectSettings.txt +++ b/source/command/atlas-api-projects-updateProjectSettings.txt @@ -12,9 +12,14 @@ atlas api projects updateProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the settings of the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings. @@ -59,18 +64,18 @@ Options - - false - help for updateProjectSettings - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-projects.txt b/source/command/atlas-api-projects.txt index e3b605e5..b5485765 100644 --- a/source/command/atlas-api-projects.txt +++ b/source/command/atlas-api-projects.txt @@ -12,7 +12,14 @@ atlas api projects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +`Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,29 +56,29 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback at `_: Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback at `_: Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - `Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - `Public Preview: please provide feedback at `_: Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback at `_: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - `Public Preview: please provide feedback at `_: Returns details about the project identified by its name. -* :ref:`atlas-api-projects-getProjectInvitation` - `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - `Public Preview: please provide feedback at `_: Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - `Public Preview: please provide feedback at `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - `Public Preview: please provide feedback at `_: Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - `Public Preview: please provide feedback at `_: Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback at `_: Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-returnAllIpAddresses` - `Public Preview: please provide feedback at `_: Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback at `_: Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - `Public Preview: please provide feedback at `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - `Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - `Public Preview: please provide feedback at `_: Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback `_: Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback `_: Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - `Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - `Public Preview: please provide feedback `_: Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback `_: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - `Public Preview: please provide feedback `_: Returns details about the project identified by its name. +* :ref:`atlas-api-projects-getProjectInvitation` - `Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - `Public Preview: please provide feedback `_: Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - `Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - `Public Preview: please provide feedback `_: Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - `Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - `Public Preview: please provide feedback `_: Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback `_: Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-returnAllIpAddresses` - `Public Preview: please provide feedback `_: Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback `_: Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - `Public Preview: please provide feedback `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +* :ref:`atlas-api-projects-updateProjectInvitationById` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. +* :ref:`atlas-api-projects-updateProjectRoles` - `Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - `Public Preview: please provide feedback `_: Updates the settings of the specified project. .. toctree:: diff --git a/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index d20b8bc1..4df2c65d 100644 --- a/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Configures the project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration. @@ -57,18 +62,18 @@ Options - - false - help for createPushBasedLogConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index 6811e076..7dd590b4 100644 --- a/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport deletePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. +`Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration. @@ -53,18 +58,18 @@ Options - - false - help for deletePushBasedLogConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api pushBasedLogExport deletePushBasedLogConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api pushBasedLogExport deletePushBasedLogConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index 33828f03..6be515c9 100644 --- a/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Fetches the current project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration. @@ -53,18 +58,18 @@ Options - - false - help for getPushBasedLogConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api pushBasedLogExport getPushBasedLogConfiguration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api pushBasedLogExport getPushBasedLogConfiguration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index 0884059f..a81705f5 100644 --- a/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/source/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration. @@ -57,18 +62,18 @@ Options - - false - help for updatePushBasedLogConfiguration - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-pushBasedLogExport.txt b/source/command/atlas-api-pushBasedLogExport.txt index 030946a3..4a27e38c 100644 --- a/source/command/atlas-api-pushBasedLogExport.txt +++ b/source/command/atlas-api-pushBasedLogExport.txt @@ -12,7 +12,12 @@ atlas api pushBasedLogExport :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +`Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Atlas exports logs every 5 minutes. @@ -51,10 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. .. toctree:: diff --git a/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index 8117a85b..901de65a 100644 --- a/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies createAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy. @@ -55,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index 93a1f11f..dbdb6d99 100644 --- a/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies deleteAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy. @@ -51,18 +56,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --resourcePolicyId - string - true @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api resourcePolicies deleteAtlasResourcePolicy --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --resourcePolicyId 32b6e34b3d91647abb20e7b8 + atlas api resourcePolicies deleteAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index a6ebb997..906be30f 100644 --- a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies getAtlasResourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all Atlas Resource Policies for the org. +`Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies. @@ -51,18 +56,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api resourcePolicies getAtlasResourcePolicies --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api resourcePolicies getAtlasResourcePolicies --version 2024-08-05 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 3bf81cdf..349824f9 100644 --- a/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies getAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy. @@ -51,18 +56,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --resourcePolicyId - string - true @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api resourcePolicies getAtlasResourcePolicy --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --resourcePolicyId 32b6e34b3d91647abb20e7b8 + atlas api resourcePolicies getAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index d9bafb96..3d71862c 100644 --- a/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/source/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies getResourcesNonCompliant :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all non-compliant resources for an org. +`Public Preview: please provide feedback `_: Return all non-compliant resources for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant. @@ -51,18 +56,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api resourcePolicies getResourcesNonCompliant --version 2024-08-05 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api resourcePolicies getResourcesNonCompliant --version 2024-08-05 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index 95724f1f..2f95973b 100644 --- a/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies updateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy. @@ -55,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --resourcePolicyId - string - true diff --git a/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index 3227fa76..4a846de4 100644 --- a/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/source/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -12,7 +12,12 @@ atlas api resourcePolicies validateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Validate one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy. @@ -55,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-resourcePolicies.txt b/source/command/atlas-api-resourcePolicies.txt index bc963944..02cc4408 100644 --- a/source/command/atlas-api-resourcePolicies.txt +++ b/source/command/atlas-api-resourcePolicies.txt @@ -12,7 +12,14 @@ atlas api resourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Configure and manage Atlas Resource Policies within your organization. +`Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,13 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback at `_: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback at `_: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback `_: Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. .. toctree:: diff --git a/source/command/atlas-api-rollingIndex-createRollingIndex.txt b/source/command/atlas-api-rollingIndex-createRollingIndex.txt index 01dab375..e5783b89 100644 --- a/source/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/source/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -12,9 +12,14 @@ atlas api rollingIndex createRollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex. @@ -63,18 +68,18 @@ Options - - false - help for createRollingIndex - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,18 +102,18 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ +-------- .. tabs:: + .. tab:: Example :tabid: 2023-01-01_2dspere_index - 2dspere Index - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # 2dspere Index { "collation": { "alternate": "non-ignorable", @@ -140,23 +145,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # 2dspere Index + atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 1 :tabid: 2023-01-01_partial_index - Partial Index - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Partial Index { "collation": { "alternate": "non-ignorable", @@ -188,23 +193,23 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Partial Index + atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment .. tab:: Example 2 :tabid: 2023-01-01_sparse_index - Sparse Index - - Create the file below and save it as `payload.json` + Create the file below and save it as ``payload.json`` .. code-block:: + # Sparse Index { "collation": { "alternate": "non-ignorable", @@ -232,11 +237,12 @@ Examples .. Code end marker, please don't delete this comment - After creating `payload.json`, run the command below in the same directory. + After creating ``payload.json``, run the command below in the same directory. .. code-block:: - atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + # Sparse Index + atlas api rollingIndex createRollingIndex --version 2023-01-01 --file payload.json --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-rollingIndex.txt b/source/command/atlas-api-rollingIndex.txt index 44bd0f71..1a581a5b 100644 --- a/source/command/atlas-api-rollingIndex.txt +++ b/source/command/atlas-api-rollingIndex.txt @@ -12,7 +12,12 @@ atlas api rollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one index to a database deployment in a rolling manner. +`Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster. @@ -51,7 +56,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner. .. toctree:: diff --git a/source/command/atlas-api-root-getSystemStatus.txt b/source/command/atlas-api-root-getSystemStatus.txt index 9a75c71e..633e7bea 100644 --- a/source/command/atlas-api-root-getSystemStatus.txt +++ b/source/command/atlas-api-root-getSystemStatus.txt @@ -12,7 +12,12 @@ atlas api root getSystemStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: This resource returns information about the MongoDB application along with API key meta data. +`Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus. @@ -47,18 +52,18 @@ Options - - false - help for getSystemStatus - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -80,14 +85,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api root getSystemStatus --version 2023-01-01 --envelope false --pretty false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 1094287e..f328e816 100644 --- a/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/source/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -12,7 +12,12 @@ atlas api root returnAllControlPlaneIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all control plane IP addresses. +`Public Preview: please provide feedback `_: Returns all control plane IP addresses. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses. @@ -47,11 +52,11 @@ Options - - false - help for returnAllControlPlaneIpAddresses - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -76,14 +81,3 @@ Inherited Options - false - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. -Examples ------------------ - -Run the command below. - -.. code-block:: - - atlas api root returnAllControlPlaneIpAddresses --version 2023-11-15 --envelope false - -.. Code end marker, please don't delete this comment - diff --git a/source/command/atlas-api-root.txt b/source/command/atlas-api-root.txt index 123c460b..4c6c5b27 100644 --- a/source/command/atlas-api-root.txt +++ b/source/command/atlas-api-root.txt @@ -12,7 +12,12 @@ atlas api root :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +`Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This starts the MongoDB Cloud API. @@ -51,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback at `_: This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `Public Preview: please provide feedback at `_: Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `Public Preview: please provide feedback `_: Returns all control plane IP addresses. .. toctree:: diff --git a/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt index 4acc409f..294259f9 100644 --- a/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -12,12 +12,17 @@ atlas api serverlessInstances createServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +`Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. -Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. +Creates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance. @@ -62,18 +67,18 @@ Options - - false - help for createServerlessInstance - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 1bd4fbd8..9a5ebfa3 100644 --- a/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -12,9 +12,14 @@ atlas api serverlessInstances deleteServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the deleteFlexCluster endpoint instead. @@ -62,18 +67,18 @@ Options - string - true - Human-readable label that identifies the serverless instance. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -104,13 +109,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serverlessInstances deleteServerlessInstance --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api serverlessInstances deleteServerlessInstance --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 58fa0ed8..7b225f36 100644 --- a/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -12,9 +12,14 @@ atlas api serverlessInstances getServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one serverless instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. This endpoint will be sunset in January 2026. Please use the getFlexCluster endpoint instead. @@ -62,18 +67,18 @@ Options - string - true - Human-readable label that identifies the serverless instance. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serverlessInstances getServerlessInstance --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --name [name] --pretty false + atlas api serverlessInstances getServerlessInstance --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --name [name] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt index c15882df..a35b52ba 100644 --- a/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/source/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -12,9 +12,14 @@ atlas api serverlessInstances listServerlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all serverless instances in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint also lists Flex clusters that were created using the createServerlessInstance endpoint or former Serverless instances that have been migrated to Flex clusters, until January 2026 after which this endpoint will be sunset. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the listFlexClusters endpoint instead. @@ -66,11 +71,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -81,7 +86,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -104,13 +109,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serverlessInstances listServerlessInstances --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api serverlessInstances listServerlessInstances --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 0e662a89..6669e0c4 100644 --- a/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/source/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -12,9 +12,14 @@ atlas api serverlessInstances updateServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. +`Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead. @@ -66,18 +71,18 @@ Options - string - true - Human-readable label that identifies the serverless instance. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serverlessInstances.txt b/source/command/atlas-api-serverlessInstances.txt index eaacf209..0acc578a 100644 --- a/source/command/atlas-api-serverlessInstances.txt +++ b/source/command/atlas-api-serverlessInstances.txt @@ -12,7 +12,14 @@ atlas api serverlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes serverless instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback at `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `Public Preview: please provide feedback at `_: Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `Public Preview: please provide feedback at `_: Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `Public Preview: please provide feedback `_: Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. .. toctree:: diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index 0d66e128..c55c9049 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or 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. @@ -69,11 +74,11 @@ Options - string - true - Human-readable label that identifies the serverless instance for which the tenant endpoint will be created. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index f292cef4..68bb9d0e 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. +`Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. @@ -66,11 +71,11 @@ Options - string - true - Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] + atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index 90ac21e4..bbcf7477 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -66,11 +71,11 @@ Options - string - true - Human-readable label that identifies the serverless instance associated with the tenant endpoint. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] + atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 7ab86bbf..174ad335 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all private endpoints for one serverless instance. +`Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + You must have at least the Project Read Only role for the project to successfully call this resource. @@ -62,11 +67,11 @@ Options - string - true - Human-readable label that identifies the serverless instance associated with the tenant endpoint. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -92,13 +97,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] + atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index b49384a4..5ba15611 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -12,9 +12,14 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead. @@ -70,11 +75,11 @@ Options - string - true - Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-serverlessPrivateEndpoints.txt b/source/command/atlas-api-serverlessPrivateEndpoints.txt index 15655309..d4eeba2c 100644 --- a/source/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/source/command/atlas-api-serverlessPrivateEndpoints.txt @@ -12,7 +12,12 @@ atlas api serverlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoints for serverless instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To learn more, see the Atlas Administration API tab on the following tutorial. @@ -51,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. .. toctree:: diff --git a/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index 03ecafd1..1f0e5aed 100644 --- a/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts addProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Assigns the specified Service Account to the specified Project. +`Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount. @@ -63,18 +66,18 @@ Options - - false - help for addProjectServiceAccount - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index 906723f6..bfceb794 100644 --- a/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts createProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Service Account for the specified Project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount. @@ -59,18 +64,18 @@ Options - - false - help for createProjectServiceAccount - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 0b846bec..646c014a 100644 --- a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts createProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Resources require all API requests to originate from IP addresses on the API access list. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList. @@ -71,11 +76,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 696da2f9..be806d19 100644 --- a/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts createProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create a secret for the specified Service Account in the specified Project. +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret. @@ -63,18 +66,18 @@ Options - - false - help for createProjectServiceAccountSecret - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createServiceAccount.txt b/source/command/atlas-api-serviceAccounts-createServiceAccount.txt index 7ca4e692..f6db7b32 100644 --- a/source/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts createServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Service Account for the specified Organization. +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount. @@ -57,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index ef4b3c00..2201aafa 100644 --- a/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts createServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Resources require all API requests to originate from IP addresses on the API access list. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList. @@ -69,11 +74,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -84,7 +89,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index 80729484..31cf2fd0 100644 --- a/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts createServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create a secret for the specified Service Account. +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret. @@ -61,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 2a6bb14f..c081cb8e 100644 --- a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts deleteProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified Service Account from the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount. @@ -59,18 +64,18 @@ Options - - false - help for deleteProjectServiceAccount - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts deleteProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api serviceAccounts deleteProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 72463d45..32234dad 100644 --- a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't remove the requesting IP address from the access list. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry. @@ -63,18 +68,18 @@ Options - string - true - One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 192.0.2.0%2F24 --pretty false + atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 192.0.2.0%2F24 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index 32d037dd..ece1ea74 100644 --- a/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret. @@ -59,18 +62,18 @@ Options - - false - help for deleteProjectServiceAccountSecret - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --secretId - string - true @@ -97,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts deleteProjectServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --secretId [secretId] + atlas api serviceAccounts deleteProjectServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --secretId [secretId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index ff0db32d..640f1ede 100644 --- a/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts deleteServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account. +`Public Preview: please provide feedback `_: Deletes the specified Service Account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount. @@ -57,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts deleteServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api serviceAccounts deleteServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index c14ba383..086992af 100644 --- a/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/source/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can't remove the requesting IP address from the access list. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry. @@ -61,18 +66,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts deleteServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false + atlas api serviceAccounts deleteServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index b016c5e3..f677b047 100644 --- a/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/source/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts deleteServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret. @@ -57,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --secretId - string - true @@ -95,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts deleteServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --secretId [secretId] + atlas api serviceAccounts deleteServiceAccountSecret --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 --secretId [secretId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index cd1710c5..3e43642c 100644 --- a/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts getProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Service Account in the specified Project. +`Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount. @@ -59,18 +62,18 @@ Options - - false - help for getProjectServiceAccount - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts getProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api serviceAccounts getProjectServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-getServiceAccount.txt b/source/command/atlas-api-serviceAccounts-getServiceAccount.txt index b228d086..426b6432 100644 --- a/source/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts getServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified Service Account. +`Public Preview: please provide feedback `_: Returns the specified Service Account. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount. @@ -57,18 +60,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -91,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts getServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false + atlas api serviceAccounts getServiceAccount --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index b4a69d91..acfd0858 100644 --- a/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts listProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the project. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList. @@ -67,11 +70,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -82,7 +85,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -105,13 +108,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts listProjectServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api serviceAccounts listProjectServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 18d1bf18..f1cb787d 100644 --- a/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/source/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts listProjectServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Project. +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts. @@ -59,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -74,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts listProjectServiceAccounts --version 2024-08-05 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api serviceAccounts listProjectServiceAccounts --version 2024-08-05 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 7134c7ff..12a422d1 100644 --- a/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/source/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts listServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList. @@ -65,11 +68,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -80,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -103,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts listServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api serviceAccounts listServiceAccountAccessList --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 2c56cb45..77ba465a 100644 --- a/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/source/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts listServiceAccountProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of all projects the specified Service Account is a part of. +`Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects. @@ -61,11 +64,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -76,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -99,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts listServiceAccountProjects --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --envelope false --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api serviceAccounts listServiceAccountProjects --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 70d60a77..26a540df 100644 --- a/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/source/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts listServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Organization. +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts. @@ -57,11 +60,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +75,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api serviceAccounts listServiceAccounts --version 2024-08-05 --envelope false --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api serviceAccounts listServiceAccounts --version 2024-08-05 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 52558efa..1dbdd270 100644 --- a/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts updateProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Service Account in the specified Project. +`Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount. @@ -63,18 +66,18 @@ Options - - false - help for updateProjectServiceAccount - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 3507c3fb..0e62de14 100644 --- a/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/source/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -12,9 +12,12 @@ atlas api serviceAccounts updateServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the specified Service Account in the specified Organization. +`Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + -Available as a preview feature. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount. @@ -61,18 +64,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-serviceAccounts.txt b/source/command/atlas-api-serviceAccounts.txt index 7b52a253..096b1c20 100644 --- a/source/command/atlas-api-serviceAccounts.txt +++ b/source/command/atlas-api-serviceAccounts.txt @@ -12,9 +12,14 @@ atlas api serviceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Endpoints for managing Service Accounts and secrets. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. Options ------- @@ -51,28 +56,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback at `_: Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `Public Preview: please provide feedback at `_: Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `Public Preview: please provide feedback at `_: Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `Public Preview: please provide feedback at `_: Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `Public Preview: please provide feedback at `_: Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `Public Preview: please provide feedback at `_: Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback at `_: Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback at `_: Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `Public Preview: please provide feedback at `_: Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `Public Preview: please provide feedback at `_: Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `Public Preview: please provide feedback at `_: Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `Public Preview: please provide feedback `_: Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `Public Preview: please provide feedback `_: Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `Public Preview: please provide feedback `_: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback `_: Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `Public Preview: please provide feedback `_: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback `_: Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. .. toctree:: diff --git a/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index d57ceaed..68624719 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. -MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the createFlexBackupRestoreJob endpoint instead. @@ -66,18 +71,18 @@ Options - - false - help for createSharedClusterBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index 135a634e..8098fc99 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -12,9 +12,14 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. -To use this resource, the requesting API Key must have the Project Read Only role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackupRestoreJob endpoint instead. @@ -62,18 +67,18 @@ Options - - false - help for getSharedClusterBackupRestoreJob - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --restoreId - string - true @@ -100,13 +105,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --restoreId [restoreId] + atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --restoreId [restoreId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 5b908ba0..8e878721 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -12,9 +12,14 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the listFlexBackupRestoreJobs endpoint instead. @@ -62,18 +67,18 @@ Options - - false - help for listSharedClusterBackupRestoreJobs - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierRestoreJobs.txt b/source/command/atlas-api-sharedTierRestoreJobs.txt index 2b220849..415f404b 100644 --- a/source/command/atlas-api-sharedTierRestoreJobs.txt +++ b/source/command/atlas-api-sharedTierRestoreJobs.txt @@ -12,7 +12,14 @@ atlas api sharedTierRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and adds restore jobs for shared-tier database deployments. +`Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster. .. toctree:: diff --git a/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index 0c335a12..7bb3e380 100644 --- a/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/source/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -12,9 +12,14 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead. @@ -66,18 +71,18 @@ Options - - false - help for downloadSharedClusterBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index a901c0a6..fc3a0159 100644 --- a/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/source/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -12,9 +12,14 @@ atlas api sharedTierSnapshots getSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026, after which this endpoint will be sunset. Please use the getFlexBackup endpoint instead. @@ -62,18 +67,18 @@ Options - - false - help for getSharedClusterBackup - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --snapshotId - string - true @@ -100,13 +105,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api sharedTierSnapshots getSharedClusterBackup --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId] + atlas api sharedTierSnapshots getSharedClusterBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index b8361e77..390bbf16 100644 --- a/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/source/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -12,9 +12,14 @@ atlas api sharedTierSnapshots listSharedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This API also works for Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters, until January 2026, after which this endpoint will be sunset. Please use the listFlexBackups endpoint instead. @@ -62,18 +67,18 @@ Options - - false - help for listSharedClusterBackups - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -96,13 +101,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api sharedTierSnapshots listSharedClusterBackups --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api sharedTierSnapshots listSharedClusterBackups --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-sharedTierSnapshots.txt b/source/command/atlas-api-sharedTierSnapshots.txt index 310091f2..ca50d27f 100644 --- a/source/command/atlas-api-sharedTierSnapshots.txt +++ b/source/command/atlas-api-sharedTierSnapshots.txt @@ -12,7 +12,14 @@ atlas api sharedTierSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and requests to download shared-tier database deployment snapshots. +`Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster. .. toctree:: diff --git a/source/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/source/command/atlas-api-streams-acceptVpcPeeringConnection.txt index 4f273506..6d39156a 100644 --- a/source/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/source/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api streams acceptVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests the acceptance of an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection. @@ -61,11 +66,11 @@ Options - string - true - The VPC Peering Connection id. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) diff --git a/source/command/atlas-api-streams-createPrivateLinkConnection.txt b/source/command/atlas-api-streams-createPrivateLinkConnection.txt index f985757f..b2571549 100644 --- a/source/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/source/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -12,9 +12,14 @@ atlas api streams createPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection. @@ -59,18 +64,18 @@ Options - - false - help for createPrivateLinkConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-streams-createStreamConnection.txt b/source/command/atlas-api-streams-createStreamConnection.txt index f502f05b..d9bbed86 100644 --- a/source/command/atlas-api-streams-createStreamConnection.txt +++ b/source/command/atlas-api-streams-createStreamConnection.txt @@ -12,9 +12,14 @@ atlas api streams createStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection. @@ -59,18 +64,18 @@ Options - - false - help for createStreamConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams-createStreamInstance.txt b/source/command/atlas-api-streams-createStreamInstance.txt index b8be5b78..59bb82ef 100644 --- a/source/command/atlas-api-streams-createStreamInstance.txt +++ b/source/command/atlas-api-streams-createStreamInstance.txt @@ -12,9 +12,14 @@ atlas api streams createStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance. @@ -59,18 +64,18 @@ Options - - false - help for createStreamInstance - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index e9e574c1..0e63dc30 100644 --- a/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/source/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -12,9 +12,14 @@ atlas api streams createStreamInstanceWithSampleConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections. @@ -59,18 +64,18 @@ Options - - false - help for createStreamInstanceWithSampleConnections - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-streams-createStreamProcessor.txt b/source/command/atlas-api-streams-createStreamProcessor.txt index ceb0e9a0..a280e389 100644 --- a/source/command/atlas-api-streams-createStreamProcessor.txt +++ b/source/command/atlas-api-streams-createStreamProcessor.txt @@ -12,9 +12,14 @@ atlas api streams createStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor. @@ -59,18 +64,18 @@ Options - - false - help for createStreamProcessor - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams-deletePrivateLinkConnection.txt b/source/command/atlas-api-streams-deletePrivateLinkConnection.txt index 3b7f6167..823c7719 100644 --- a/source/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/source/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -12,9 +12,14 @@ atlas api streams deletePrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection. @@ -59,18 +64,18 @@ Options - - false - help for deletePrivateLinkConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams deletePrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false + atlas api streams deletePrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteStreamConnection.txt b/source/command/atlas-api-streams-deleteStreamConnection.txt index 585df57c..122567f2 100644 --- a/source/command/atlas-api-streams-deleteStreamConnection.txt +++ b/source/command/atlas-api-streams-deleteStreamConnection.txt @@ -12,9 +12,14 @@ atlas api streams deleteStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection. @@ -59,18 +64,18 @@ Options - - false - help for deleteStreamConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams deleteStreamConnection --version 2023-02-01 --connectionName [connectionName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api streams deleteStreamConnection --version 2023-02-01 --connectionName [connectionName] --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteStreamInstance.txt b/source/command/atlas-api-streams-deleteStreamInstance.txt index 53d40e2d..bef646f2 100644 --- a/source/command/atlas-api-streams-deleteStreamInstance.txt +++ b/source/command/atlas-api-streams-deleteStreamInstance.txt @@ -12,9 +12,14 @@ atlas api streams deleteStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance. @@ -55,18 +60,18 @@ Options - - false - help for deleteStreamInstance - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams deleteStreamInstance --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --tenantName [tenantName] + atlas api streams deleteStreamInstance --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteStreamProcessor.txt b/source/command/atlas-api-streams-deleteStreamProcessor.txt index fc08fe0e..9bb76318 100644 --- a/source/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/source/command/atlas-api-streams-deleteStreamProcessor.txt @@ -12,9 +12,14 @@ atlas api streams deleteStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor. @@ -55,18 +60,18 @@ Options - - false - help for deleteStreamProcessor - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processorName - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams deleteStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams deleteStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 7e016402..2a5ecd75 100644 --- a/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/source/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api streams deleteVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection. @@ -57,11 +62,11 @@ Options - string - true - The VPC Peering Connection id. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams deleteVpcPeeringConnection --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --id [id] + atlas api streams deleteVpcPeeringConnection --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --id [id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 3e377d11..56839a16 100644 --- a/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/source/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -12,9 +12,14 @@ atlas api streams downloadStreamTenantAuditLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. +`Public Preview: please provide feedback `_: 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". +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs. @@ -59,11 +64,11 @@ Options - - false - help for downloadStreamTenantAuditLogs - * - --output + * - -o, --output - string - false - preferred api format, can be ["gzip"] This value defaults to "gzip". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams downloadStreamTenantAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName] + atlas api streams downloadStreamTenantAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getAccountDetails.txt b/source/command/atlas-api-streams-getAccountDetails.txt index 8bb85dfa..44a7c3b2 100644 --- a/source/command/atlas-api-streams-getAccountDetails.txt +++ b/source/command/atlas-api-streams-getAccountDetails.txt @@ -12,7 +12,12 @@ atlas api streams getAccountDetails :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Account ID, and the VPC ID for the group and region specified. +`Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails. @@ -57,11 +62,11 @@ Options - - false - help for getAccountDetails - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName] + atlas api streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index 0b07d7f6..a2f79125 100644 --- a/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/source/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -12,7 +12,12 @@ atlas api streams getActiveVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of active incoming VPC Peering Connections. +`Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections. @@ -57,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getActiveVpcPeeringConnections --version 2024-11-13 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api streams getActiveVpcPeeringConnections --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getPrivateLinkConnection.txt b/source/command/atlas-api-streams-getPrivateLinkConnection.txt index dda6769c..8d596d6e 100644 --- a/source/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/source/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -12,9 +12,14 @@ atlas api streams getPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection. @@ -59,11 +64,11 @@ Options - - false - help for getPrivateLinkConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getPrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api streams getPrivateLinkConnection --version 2023-02-01 --connectionId [connectionId] --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getStreamConnection.txt b/source/command/atlas-api-streams-getStreamConnection.txt index 0eb1a172..30c844fe 100644 --- a/source/command/atlas-api-streams-getStreamConnection.txt +++ b/source/command/atlas-api-streams-getStreamConnection.txt @@ -12,9 +12,14 @@ atlas api streams getStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection. @@ -59,11 +64,11 @@ Options - - false - help for getStreamConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getStreamConnection --version 2023-02-01 --connectionName [connectionName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] + atlas api streams getStreamConnection --version 2023-02-01 --connectionName [connectionName] --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getStreamInstance.txt b/source/command/atlas-api-streams-getStreamInstance.txt index c17bc048..d4fda560 100644 --- a/source/command/atlas-api-streams-getStreamInstance.txt +++ b/source/command/atlas-api-streams-getStreamInstance.txt @@ -12,9 +12,14 @@ atlas api streams getStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance. @@ -59,11 +64,11 @@ Options - - false - Flag to indicate whether connections information should be included in the stream instance. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getStreamInstance --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] + atlas api streams getStreamInstance --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getStreamProcessor.txt b/source/command/atlas-api-streams-getStreamProcessor.txt index 9a54dc5a..e942f22f 100644 --- a/source/command/atlas-api-streams-getStreamProcessor.txt +++ b/source/command/atlas-api-streams-getStreamProcessor.txt @@ -12,9 +12,14 @@ atlas api streams getStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor. @@ -55,18 +60,18 @@ Options - - false - help for getStreamProcessor - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processorName - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams getStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-getVpcPeeringConnections.txt b/source/command/atlas-api-streams-getVpcPeeringConnections.txt index 937aaa77..8253cf82 100644 --- a/source/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/source/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -12,7 +12,12 @@ atlas api streams getVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of incoming VPC Peering Connections. +`Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections. @@ -57,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --requesterAccountId - string - true @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams getVpcPeeringConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false --requesterAccountId [requesterAccountId] + atlas api streams getVpcPeeringConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --requesterAccountId [requesterAccountId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listPrivateLinkConnections.txt b/source/command/atlas-api-streams-listPrivateLinkConnections.txt index daf2c2f9..2e405264 100644 --- a/source/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/source/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -12,7 +12,12 @@ atlas api streams listPrivateLinkConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Private Link connections for the specified project. +`Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -59,11 +64,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -74,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams listPrivateLinkConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api streams listPrivateLinkConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listStreamConnections.txt b/source/command/atlas-api-streams-listStreamConnections.txt index 63d1c945..906035e3 100644 --- a/source/command/atlas-api-streams-listStreamConnections.txt +++ b/source/command/atlas-api-streams-listStreamConnections.txt @@ -12,7 +12,12 @@ atlas api streams listStreamConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all connections of the stream instance for the specified project. +`Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -59,11 +64,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -74,7 +79,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams listStreamConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false --tenantName [tenantName] + atlas api streams listStreamConnections --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listStreamInstances.txt b/source/command/atlas-api-streams-listStreamInstances.txt index 605a9cb3..6ffd4b53 100644 --- a/source/command/atlas-api-streams-listStreamInstances.txt +++ b/source/command/atlas-api-streams-listStreamInstances.txt @@ -12,7 +12,12 @@ atlas api streams listStreamInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all stream instances for the specified project. +`Public Preview: please provide feedback `_: Returns all stream instances for the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances. @@ -57,11 +62,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -72,7 +77,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -95,13 +100,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams listStreamInstances --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false + atlas api streams listStreamInstances --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-listStreamProcessors.txt b/source/command/atlas-api-streams-listStreamProcessors.txt index cbd3ca62..048a7240 100644 --- a/source/command/atlas-api-streams-listStreamProcessors.txt +++ b/source/command/atlas-api-streams-listStreamProcessors.txt @@ -12,9 +12,14 @@ atlas api streams listStreamProcessors :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams listStreamProcessors --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --tenantName [tenantName] + atlas api streams listStreamProcessors --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-modifyStreamProcessor.txt b/source/command/atlas-api-streams-modifyStreamProcessor.txt index 8eae958a..60e61de3 100644 --- a/source/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/source/command/atlas-api-streams-modifyStreamProcessor.txt @@ -12,9 +12,14 @@ atlas api streams modifyStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor. @@ -59,18 +64,18 @@ Options - - false - help for modifyStreamProcessor - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processorName - string - true diff --git a/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 4f067d2a..6add535e 100644 --- a/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/source/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -12,7 +12,12 @@ atlas api streams rejectVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests the rejection of an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection. @@ -57,11 +62,11 @@ Options - string - true - The VPC Peering Connection id. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -87,13 +92,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams rejectVpcPeeringConnection --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --id [id] + atlas api streams rejectVpcPeeringConnection --version 2023-02-01 --groupId 32b6e34b3d91647abb20e7b8 --id [id] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-startStreamProcessor.txt b/source/command/atlas-api-streams-startStreamProcessor.txt index 2b7ca199..f21c5947 100644 --- a/source/command/atlas-api-streams-startStreamProcessor.txt +++ b/source/command/atlas-api-streams-startStreamProcessor.txt @@ -12,9 +12,14 @@ atlas api streams startStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor. @@ -55,18 +60,18 @@ Options - - false - help for startStreamProcessor - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processorName - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams startStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams startStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-startStreamProcessorWith.txt b/source/command/atlas-api-streams-startStreamProcessorWith.txt new file mode 100644 index 00000000..c42b0bd8 --- /dev/null +++ b/source/command/atlas-api-streams-startStreamProcessorWith.txt @@ -0,0 +1,107 @@ +.. _atlas-api-streams-startStreamProcessorWith: + +========================================== +atlas api streams startStreamProcessorWith +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. + +This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessorWith. + +For more information and examples, see the referenced API documentation linked above. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas api streams startStreamProcessorWith [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --envelope + - envelope + - false + - Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. + * - --file + - string + - false + - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both. + * - --groupId + - string + - true + - Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. + + **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. + * - -h, --help + - + - false + - help for startStreamProcessorWith + * - -o, --output + - string + - false + - preferred api format, can be ["json", go-template] This value defaults to "json". + * - --outputFile + - string + - false + - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) + * - --pretty + - + - false + - Flag that indicates whether the response body should be in the prettyprint format. + * - --processorName + - string + - true + - Human-readable label that identifies the stream processor. + * - --tenantName + - string + - true + - Human-readable label that identifies the stream instance. + * - --version + - string + - false + - api version to use when calling the api call [options: "2025-03-12"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-03-12". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-api-streams-stopStreamProcessor.txt b/source/command/atlas-api-streams-stopStreamProcessor.txt index 2c2557b4..1e7f84d1 100644 --- a/source/command/atlas-api-streams-stopStreamProcessor.txt +++ b/source/command/atlas-api-streams-stopStreamProcessor.txt @@ -12,9 +12,14 @@ atlas api streams stopStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor. @@ -55,18 +60,18 @@ Options - - false - help for stopStreamProcessor - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --processorName - string - true @@ -97,13 +102,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api streams stopStreamProcessor --version 2024-05-30 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --processorName [processorName] --tenantName [tenantName] + atlas api streams stopStreamProcessor --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8 --processorName [processorName] --tenantName [tenantName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-streams-updateStreamConnection.txt b/source/command/atlas-api-streams-updateStreamConnection.txt index 4c98482c..d727f29d 100644 --- a/source/command/atlas-api-streams-updateStreamConnection.txt +++ b/source/command/atlas-api-streams-updateStreamConnection.txt @@ -12,9 +12,14 @@ atlas api streams updateStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection. @@ -63,18 +68,18 @@ Options - - false - help for updateStreamConnection - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams-updateStreamInstance.txt b/source/command/atlas-api-streams-updateStreamInstance.txt index 8f418add..831b882a 100644 --- a/source/command/atlas-api-streams-updateStreamInstance.txt +++ b/source/command/atlas-api-streams-updateStreamInstance.txt @@ -12,9 +12,14 @@ atlas api streams updateStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one stream instance in the specified project. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance. @@ -59,18 +64,18 @@ Options - - false - help for updateStreamInstance - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --tenantName - string - true diff --git a/source/command/atlas-api-streams.txt b/source/command/atlas-api-streams.txt index d4b7171b..34375e74 100644 --- a/source/command/atlas-api-streams.txt +++ b/source/command/atlas-api-streams.txt @@ -12,7 +12,12 @@ atlas api streams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Streams Instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This resource requires your project ID. @@ -51,35 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - `Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - `Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - `Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - `Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - `Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - `Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - `Public Preview: please provide feedback at `_: Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - `Public Preview: please provide feedback at `_: Returns a list of active incoming VPC Peering Connections. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - `Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - `Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - `Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - `Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - `Public Preview: please provide feedback at `_: Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - `Public Preview: please provide feedback at `_: Returns all Private Link connections for the specified project. -* :ref:`atlas-api-streams-listStreamConnections` - `Public Preview: please provide feedback at `_: Returns all connections of the stream instance for the specified project. -* :ref:`atlas-api-streams-listStreamInstances` - `Public Preview: please provide feedback at `_: Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - `Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - `Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - `Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - `Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - `Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - `Public Preview: please provide feedback at `_: Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - `Public Preview: please provide feedback `_: Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - `Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - `Public Preview: please provide feedback `_: Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - `Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `Public Preview: please provide feedback `_: Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - `Public Preview: please provide feedback `_: Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - `Public Preview: please provide feedback `_: Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - `Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - `Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - `Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - `Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - `Public Preview: please provide feedback `_: Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - `Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - `Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - `Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - `Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. +* :ref:`atlas-api-streams-listStreamConnections` - `Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. +* :ref:`atlas-api-streams-listStreamInstances` - `Public Preview: please provide feedback `_: Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - `Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - `Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - `Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-startStreamProcessorWith` - `Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - `Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - `Public Preview: please provide feedback `_: Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - `Public Preview: please provide feedback `_: Update one stream instance in the specified project. .. toctree:: @@ -111,6 +117,7 @@ Related Commands modifyStreamProcessor rejectVpcPeeringConnection startStreamProcessor + startStreamProcessorWith stopStreamProcessor updateStreamConnection updateStreamInstance diff --git a/source/command/atlas-api-teams-addAllTeamsToProject.txt b/source/command/atlas-api-teams-addAllTeamsToProject.txt index 2ae84e27..48f37080 100644 --- a/source/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/source/command/atlas-api-teams-addAllTeamsToProject.txt @@ -12,7 +12,12 @@ atlas api teams addAllTeamsToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more teams to the specified project. +`Public Preview: please provide feedback `_: Adds one or more teams to the specified project. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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. @@ -59,18 +64,18 @@ Options - - false - help for addAllTeamsToProject - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-teams-addTeamUser.txt b/source/command/atlas-api-teams-addTeamUser.txt index f1c38d70..ba4ebf62 100644 --- a/source/command/atlas-api-teams-addTeamUser.txt +++ b/source/command/atlas-api-teams-addTeamUser.txt @@ -12,9 +12,14 @@ atlas api teams addTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This endpoint is deprecated. Use Add One MongoDB Cloud User to One Team to add an active or pending user to a team. @@ -60,18 +65,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-teams-createTeam.txt b/source/command/atlas-api-teams-createTeam.txt index febd052b..06c03a38 100644 --- a/source/command/atlas-api-teams-createTeam.txt +++ b/source/command/atlas-api-teams-createTeam.txt @@ -12,9 +12,14 @@ atlas api teams createTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one team in the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-teams-deleteTeam.txt b/source/command/atlas-api-teams-deleteTeam.txt index 1e81db78..06569794 100644 --- a/source/command/atlas-api-teams-deleteTeam.txt +++ b/source/command/atlas-api-teams-deleteTeam.txt @@ -12,9 +12,14 @@ atlas api teams deleteTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +`Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. -To use this resource, the requesting API Key must have the Organization Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams deleteTeam --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamId [teamId] + atlas api teams deleteTeam --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-getTeamById.txt b/source/command/atlas-api-teams-getTeamById.txt index 055769d7..b2567437 100644 --- a/source/command/atlas-api-teams-getTeamById.txt +++ b/source/command/atlas-api-teams-getTeamById.txt @@ -12,9 +12,14 @@ atlas api teams getTeamById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams getTeamById --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamId [teamId] + atlas api teams getTeamById --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-getTeamByName.txt b/source/command/atlas-api-teams-getTeamByName.txt index b559f9a2..46fdd67e 100644 --- a/source/command/atlas-api-teams-getTeamByName.txt +++ b/source/command/atlas-api-teams-getTeamByName.txt @@ -12,9 +12,14 @@ atlas api teams getTeamByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName. @@ -53,18 +58,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamName - string - true @@ -91,13 +96,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams getTeamByName --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamName [teamName] + atlas api teams getTeamByName --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamName [teamName] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-listOrganizationTeams.txt b/source/command/atlas-api-teams-listOrganizationTeams.txt index 2c14344c..57481f41 100644 --- a/source/command/atlas-api-teams-listOrganizationTeams.txt +++ b/source/command/atlas-api-teams-listOrganizationTeams.txt @@ -12,9 +12,14 @@ atlas api teams listOrganizationTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams. @@ -61,11 +66,11 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -76,7 +81,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -99,13 +104,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams listOrganizationTeams --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false + atlas api teams listOrganizationTeams --version 2023-01-01 --orgId 4888442a3354817a7320eb61 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-listProjectTeams.txt b/source/command/atlas-api-teams-listProjectTeams.txt index 28f164ed..a25be5ea 100644 --- a/source/command/atlas-api-teams-listProjectTeams.txt +++ b/source/command/atlas-api-teams-listProjectTeams.txt @@ -12,9 +12,14 @@ atlas api teams listProjectTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams listProjectTeams --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api teams listProjectTeams --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-removeProjectTeam.txt b/source/command/atlas-api-teams-removeProjectTeam.txt index 680e40ae..7f469b5b 100644 --- a/source/command/atlas-api-teams-removeProjectTeam.txt +++ b/source/command/atlas-api-teams-removeProjectTeam.txt @@ -12,9 +12,14 @@ atlas api teams removeProjectTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +`Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -To use this resource, the requesting API Key must have the Project Owner role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam. @@ -55,11 +60,11 @@ Options - - false - help for removeProjectTeam - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -89,13 +94,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams removeProjectTeam --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] + atlas api teams removeProjectTeam --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --teamId [teamId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-removeTeamUser.txt b/source/command/atlas-api-teams-removeTeamUser.txt index 0637d394..a102ed7d 100644 --- a/source/command/atlas-api-teams-removeTeamUser.txt +++ b/source/command/atlas-api-teams-removeTeamUser.txt @@ -12,9 +12,14 @@ atlas api teams removeTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified team. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This endpoint is deprecated. Use Remove One MongoDB Cloud User from One Team to remove an active or pending user from a team. @@ -56,18 +61,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true @@ -98,13 +103,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api teams removeTeamUser --version 2023-01-01 --envelope false --orgId 4888442a3354817a7320eb61 --pretty false --teamId [teamId] --userId [userId] + atlas api teams removeTeamUser --version 2023-01-01 --orgId 4888442a3354817a7320eb61 --teamId [teamId] --userId [userId] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-teams-renameTeam.txt b/source/command/atlas-api-teams-renameTeam.txt index 89d02825..6f05792a 100644 --- a/source/command/atlas-api-teams-renameTeam.txt +++ b/source/command/atlas-api-teams-renameTeam.txt @@ -12,9 +12,14 @@ atlas api teams renameTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Renames one team in the specified organization. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam. @@ -57,18 +62,18 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-teams-updateTeamRoles.txt b/source/command/atlas-api-teams-updateTeamRoles.txt index e4043db1..f8916485 100644 --- a/source/command/atlas-api-teams-updateTeamRoles.txt +++ b/source/command/atlas-api-teams-updateTeamRoles.txt @@ -12,9 +12,14 @@ atlas api teams updateTeamRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles. @@ -59,18 +64,18 @@ Options - - false - help for updateTeamRoles - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --teamId - string - true diff --git a/source/command/atlas-api-teams.txt b/source/command/atlas-api-teams.txt index 5ade5ffa..8a585a03 100644 --- a/source/command/atlas-api-teams.txt +++ b/source/command/atlas-api-teams.txt @@ -12,7 +12,14 @@ atlas api teams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, or removes teams. +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + Options ------- @@ -49,18 +56,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback at `_: Adds one or more teams to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback at `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback at `_: Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - `Public Preview: please provide feedback at `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeProjectTeam` - `Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeTeamUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - `Public Preview: please provide feedback at `_: Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - `Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback `_: Adds one or more teams to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback `_: Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - `Public Preview: please provide feedback `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeProjectTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeTeamUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - `Public Preview: please provide feedback `_: Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - `Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team. .. toctree:: diff --git a/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index ad3b4f62..5e7f3e0f 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -12,9 +12,14 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration. @@ -71,11 +76,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 05155344..9247c173 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -12,9 +12,14 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration. @@ -59,18 +64,18 @@ Options - string - true - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api thirdPartyIntegrations deleteThirdPartyIntegration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] --pretty false + atlas api thirdPartyIntegrations deleteThirdPartyIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index e3a219b7..e3aa2ddd 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -12,9 +12,14 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration. @@ -59,18 +64,18 @@ Options - string - true - Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -93,13 +98,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api thirdPartyIntegrations getThirdPartyIntegration --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] --pretty false + atlas api thirdPartyIntegrations getThirdPartyIntegration --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --integrationType [integrationType] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 85dbd00e..74d23b2c 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -12,9 +12,14 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false @@ -101,13 +106,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api thirdPartyIntegrations listThirdPartyIntegrations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false + atlas api thirdPartyIntegrations listThirdPartyIntegrations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index ab7245ad..9c02c456 100644 --- a/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/source/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -12,9 +12,14 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration. @@ -71,11 +76,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -86,7 +91,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --version - string - false diff --git a/source/command/atlas-api-thirdPartyIntegrations.txt b/source/command/atlas-api-thirdPartyIntegrations.txt index 6aa78d9c..64054ce4 100644 --- a/source/command/atlas-api-thirdPartyIntegrations.txt +++ b/source/command/atlas-api-thirdPartyIntegrations.txt @@ -12,7 +12,12 @@ atlas api thirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes third-party service integration configurations. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + MongoDB Cloud sends alerts to each third-party service that you configure. @@ -54,11 +59,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `Public Preview: please provide feedback `_: Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service. .. toctree:: diff --git a/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index a29e45b5..2b63ddb4 100644 --- a/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/source/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -12,9 +12,14 @@ atlas api x509Authentication createDatabaseUserCertificate :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. @@ -65,18 +70,18 @@ Options - - false - help for createDatabaseUserCertificate - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - true diff --git a/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index 5088fe0f..b533aa5e 100644 --- a/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/source/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -12,7 +12,12 @@ atlas api x509Authentication disableCustomerManagedX509 :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +`Public Preview: please provide feedback `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. @@ -55,11 +60,11 @@ Options - - false - help for disableCustomerManagedX509 - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -85,13 +90,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api x509Authentication disableCustomerManagedX509 --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 + atlas api x509Authentication disableCustomerManagedX509 --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 36124935..152547af 100644 --- a/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/source/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -12,9 +12,14 @@ atlas api x509Authentication listDatabaseUserCertificates :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +`Public Preview: please provide feedback `_: 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. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + +This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates. @@ -63,11 +68,11 @@ Options - int - false - Number of items that the response returns per page. - * - --output + * - -o, --output - string - false - preferred api format, can be ["json", go-template] This value defaults to "json". - * - --output-file + * - --outputFile - string - false - file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) @@ -78,7 +83,7 @@ Options * - --pretty - - false - - Flag that indicates whether the response body should be in the prettyprint format. + - Flag that indicates whether the response body should be in the prettyprint format. * - --username - string - true @@ -105,13 +110,11 @@ Inherited Options - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. Examples ------------------ - -Run the command below. +-------- .. code-block:: - atlas api x509Authentication listDatabaseUserCertificates --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false --username [username] + atlas api x509Authentication listDatabaseUserCertificates --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --username [username] .. Code end marker, please don't delete this comment diff --git a/source/command/atlas-api-x509Authentication.txt b/source/command/atlas-api-x509Authentication.txt index c7d70276..5df3c92d 100644 --- a/source/command/atlas-api-x509Authentication.txt +++ b/source/command/atlas-api-x509Authentication.txt @@ -12,7 +12,12 @@ atlas api x509Authentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes user-managed X.509 configurations. +`Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + 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 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `Public Preview: please provide feedback at `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. -* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - `Public Preview: please provide feedback at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `Public Preview: please provide feedback `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - `Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user. .. toctree:: diff --git a/source/command/atlas-api.txt b/source/command/atlas-api.txt index 81623720..cab50924 100644 --- a/source/command/atlas-api.txt +++ b/source/command/atlas-api.txt @@ -12,7 +12,12 @@ atlas api :depth: 1 :class: singlecol -Public Preview: please provide feedback at : Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +`Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. + +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. @@ -20,8 +25,8 @@ For more information on - Atlas Administration API see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access -This feature in public preview streamlines script development by letting you interact -directly with any Atlas Administration API endpoint by using the Atlas CLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Syntax ------ @@ -138,6 +143,7 @@ In addition, the following options are available for all Atlas Administration AP - false - Help for the current command. + Options ------- @@ -173,56 +179,56 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback at `_: Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - `Public Preview: please provide feedback at `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - `Public Preview: please provide feedback at `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - `Public Preview: please provide feedback at `_: Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - `Public Preview: please provide feedback at `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - `Public Preview: please provide feedback at `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - `Public Preview: please provide feedback at `_: Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback at `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - `Public Preview: please provide feedback at `_: Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - `Public Preview: please provide feedback at `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback at `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `Public Preview: please provide feedback at `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - `Public Preview: please provide feedback at `_: Returns events. -* :ref:`atlas-api-federatedAuthentication` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - `Public Preview: please provide feedback at `_: Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - `Public Preview: please provide feedback at `_: Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - `Public Preview: please provide feedback at `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback at `_: Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback at `_: Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - `Public Preview: please provide feedback at `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback at `_: Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback at `_: Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback at `_: Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - `Public Preview: please provide feedback at `_: Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-organizations` - `Public Preview: please provide feedback at `_: Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - `Public Preview: please provide feedback at `_: Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - `Public Preview: please provide feedback at `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback at `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback at `_: Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback at `_: Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - `Public Preview: please provide feedback at `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - `Public Preview: please provide feedback at `_: Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - `Public Preview: please provide feedback at `_: Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - `Public Preview: please provide feedback at `_: Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - `Public Preview: please provide feedback at `_: Returns, adds, edits, or removes teams. -* :ref:`atlas-api-thirdPartyIntegrations` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - `Public Preview: please provide feedback at `_: Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - `Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - `Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - `Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - `Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - `Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - `Public Preview: please provide feedback `_: Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - `Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - `Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - `Public Preview: please provide feedback `_: Returns events. +* :ref:`atlas-api-federatedAuthentication` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - `Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - `Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - `Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback `_: Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - `Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-organizations` - `Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - `Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - `Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - `Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - `Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - `Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - `Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. +* :ref:`atlas-api-thirdPartyIntegrations` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - `Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/source/command/atlas-auditing-describe.txt b/source/command/atlas-auditing-describe.txt index d5e7d1b5..62d2c79c 100644 --- a/source/command/atlas-auditing-describe.txt +++ b/source/command/atlas-auditing-describe.txt @@ -14,6 +14,11 @@ atlas auditing describe Returns the auditing configuration for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-auditing-update.txt b/source/command/atlas-auditing-update.txt index 6253d205..8a5fbc5c 100644 --- a/source/command/atlas-auditing-update.txt +++ b/source/command/atlas-auditing-update.txt @@ -4,9 +4,6 @@ atlas auditing update ===================== -.. meta:: - :description: Update the auditing configuration for a specified project in Atlas using the CLI with various options for customization. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas auditing update Updates the auditing configuration for the specified project +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-auditing.txt b/source/command/atlas-auditing.txt index 0f55be98..47fecf31 100644 --- a/source/command/atlas-auditing.txt +++ b/source/command/atlas-auditing.txt @@ -4,9 +4,6 @@ atlas auditing ============== -.. meta:: - :description: Retrieve database auditing settings for MongoDB Cloud projects using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas auditing Returns database auditing settings for MongoDB Cloud projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-auth-login.txt b/source/command/atlas-auth-login.txt index 7521679a..3076bc30 100644 --- a/source/command/atlas-auth-login.txt +++ b/source/command/atlas-auth-login.txt @@ -4,9 +4,6 @@ atlas auth login ================ -.. meta:: - :description: Authenticate with Atlas using the CLI, with options for government login, browserless access, and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas auth login Authenticate with MongoDB Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-auth-logout.txt b/source/command/atlas-auth-logout.txt index 12b10436..279b985a 100644 --- a/source/command/atlas-auth-logout.txt +++ b/source/command/atlas-auth-logout.txt @@ -4,9 +4,6 @@ atlas auth logout ================= -.. meta:: - :description: Log out from the Atlas CLI using the `atlas auth logout` command with optional flags for confirmation and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas auth logout Log out of the CLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-auth-register.txt b/source/command/atlas-auth-register.txt index a2d282da..10685a26 100644 --- a/source/command/atlas-auth-register.txt +++ b/source/command/atlas-auth-register.txt @@ -4,9 +4,6 @@ atlas auth register =================== -.. meta:: - :description: Register with Atlas using the CLI command `atlas auth register`, with options for browser session and profile configuration. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas auth register Register with MongoDB Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-auth-whoami.txt b/source/command/atlas-auth-whoami.txt index c065cd18..69303e55 100644 --- a/source/command/atlas-auth-whoami.txt +++ b/source/command/atlas-auth-whoami.txt @@ -4,9 +4,6 @@ atlas auth whoami ================= -.. meta:: - :description: Verify and display your authentication state using the "atlas auth whoami" command with optional profile settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas auth whoami Verifies and displays information about your authentication state. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-auth.txt b/source/command/atlas-auth.txt index 84a99765..ad0e97c0 100644 --- a/source/command/atlas-auth.txt +++ b/source/command/atlas-auth.txt @@ -4,9 +4,6 @@ atlas auth ========== -.. meta:: - :description: Manage authentication state in the Atlas CLI, including login, logout, registration, and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas auth Manage the CLI's authentication state. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt b/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt index 37e4a125..8d8b80a5 100644 --- a/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt +++ b/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection disable Disable copy protection of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt b/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt index 3887c8ab..efd9fbfb 100644 --- a/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt +++ b/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection enable Enable copy protection of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-copyProtection.txt b/source/command/atlas-backups-compliancePolicy-copyProtection.txt index 4a57b443..fa3c107f 100644 --- a/source/command/atlas-backups-compliancePolicy-copyProtection.txt +++ b/source/command/atlas-backups-compliancePolicy-copyProtection.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-describe.txt b/source/command/atlas-backups-compliancePolicy-describe.txt index 453824e9..187dab9d 100644 --- a/source/command/atlas-backups-compliancePolicy-describe.txt +++ b/source/command/atlas-backups-compliancePolicy-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy describe Return the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-enable.txt b/source/command/atlas-backups-compliancePolicy-enable.txt index 3050689c..b2f47f48 100644 --- a/source/command/atlas-backups-compliancePolicy-enable.txt +++ b/source/command/atlas-backups-compliancePolicy-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy enable Enable Backup Compliance Policy without any configuration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt index 5cf0a602..9123d118 100644 --- a/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt +++ b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest disable Disable encryption-at-rest for the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt index ee1b5b35..c8900d81 100644 --- a/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt +++ b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest enable Enable encryption-at-rest for the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt b/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt index 8c4593ff..9cf4027d 100644 --- a/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt +++ b/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt index e304ec1e..39d59bcb 100644 --- a/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt +++ b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy pointInTimeRestores enable Enable Point-in-Time restores of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt index ef796859..e8dac410 100644 --- a/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt +++ b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy pointInTimeRestores Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-policies-describe.txt b/source/command/atlas-backups-compliancePolicy-policies-describe.txt index 67682b60..7c87c859 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-describe.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies describe Return the individual policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt index ad02d1aa..75dfa6dd 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand create Create the on-demand policy item of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt index 574787f6..ff3f5756 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand describe Return the on-demand policy item of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt index 5380a584..0b78d79d 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand update Update the on-demand policy of the backup compliance for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt index 4aad7eae..7da30510 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand Manage the on-demand policy item of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt b/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt index 302052d8..bc337f85 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled create Create a scheduled policy item for the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt b/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt index f7e60ac2..2920352a 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled describe Return the scheduled policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt b/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt index 9d2376fa..fe54c8e2 100644 --- a/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt +++ b/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled Manage the scheduled policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-policies.txt b/source/command/atlas-backups-compliancePolicy-policies.txt index 40b7bd48..0777a613 100644 --- a/source/command/atlas-backups-compliancePolicy-policies.txt +++ b/source/command/atlas-backups-compliancePolicy-policies.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies Manage the individual policy items of the backup compliance policy for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-compliancePolicy-setup.txt b/source/command/atlas-backups-compliancePolicy-setup.txt index ab2195d9..bfeaa884 100644 --- a/source/command/atlas-backups-compliancePolicy-setup.txt +++ b/source/command/atlas-backups-compliancePolicy-setup.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy setup Setup the backup compliance policy for your project with a configuration file. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-backups-compliancePolicy.txt b/source/command/atlas-backups-compliancePolicy.txt index aeb21ac9..ca60f97b 100644 --- a/source/command/atlas-backups-compliancePolicy.txt +++ b/source/command/atlas-backups-compliancePolicy.txt @@ -4,9 +4,6 @@ atlas backups compliancePolicy ============================== -.. meta:: - :description: Manage cloud backup compliance policies for your project using Atlas CLI commands, including setup and enabling options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas backups compliancePolicy Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-exports-buckets-create.txt b/source/command/atlas-backups-exports-buckets-create.txt index 82af5043..59190cfa 100644 --- a/source/command/atlas-backups-exports-buckets-create.txt +++ b/source/command/atlas-backups-exports-buckets-create.txt @@ -4,9 +4,6 @@ atlas backups exports buckets create ==================================== -.. meta:: - :description: Create an export destination for Atlas backups using an existing AWS S3 bucket with specified options and authentication requirements. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports buckets create Create an export destination for Atlas backups using an existing AWS S3 bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-exports-buckets-delete.txt b/source/command/atlas-backups-exports-buckets-delete.txt index 43c43634..87585126 100644 --- a/source/command/atlas-backups-exports-buckets-delete.txt +++ b/source/command/atlas-backups-exports-buckets-delete.txt @@ -4,9 +4,6 @@ atlas backups exports buckets delete ==================================== -.. meta:: - :description: Delete a snapshot export bucket using the Atlas CLI with options for bucket ID, force, and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports buckets delete Delete a snapshot export bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-exports-buckets-describe.txt b/source/command/atlas-backups-exports-buckets-describe.txt index b735579a..b0ff2017 100644 --- a/source/command/atlas-backups-exports-buckets-describe.txt +++ b/source/command/atlas-backups-exports-buckets-describe.txt @@ -4,9 +4,6 @@ atlas backups exports buckets describe ====================================== -.. meta:: - :description: Describe a snapshot export bucket using the Atlas CLI, requiring authentication and a bucket ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports buckets describe Return one snapshot export bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-backups-exports-buckets-list.txt b/source/command/atlas-backups-exports-buckets-list.txt index 5810fb3e..16b0e1d3 100644 --- a/source/command/atlas-backups-exports-buckets-list.txt +++ b/source/command/atlas-backups-exports-buckets-list.txt @@ -4,9 +4,6 @@ atlas backups exports buckets list ================================== -.. meta:: - :description: List cloud backup restore buckets for your project and cluster using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports buckets list List cloud backup restore buckets for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-backups-exports-buckets.txt b/source/command/atlas-backups-exports-buckets.txt index c72ae839..bbbceb92 100644 --- a/source/command/atlas-backups-exports-buckets.txt +++ b/source/command/atlas-backups-exports-buckets.txt @@ -14,6 +14,13 @@ atlas backups exports buckets Manage cloud backup export buckets for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-exports-jobs-create.txt b/source/command/atlas-backups-exports-jobs-create.txt index ce495cd0..d025c0f0 100644 --- a/source/command/atlas-backups-exports-jobs-create.txt +++ b/source/command/atlas-backups-exports-jobs-create.txt @@ -4,9 +4,6 @@ atlas backups exports jobs create ================================= -.. meta:: - :description: Export a backup snapshot from an M10 or higher Atlas cluster to an AWS S3 bucket using the Atlas CLI command with required options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports jobs create Export one backup snapshot for an M10 or higher Atlas cluster to an existing AWS S3 bucket. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-exports-jobs-describe.txt b/source/command/atlas-backups-exports-jobs-describe.txt index 3ad2d1a1..aa5ab531 100644 --- a/source/command/atlas-backups-exports-jobs-describe.txt +++ b/source/command/atlas-backups-exports-jobs-describe.txt @@ -4,9 +4,6 @@ atlas backups exports jobs describe =================================== -.. meta:: - :description: Retrieve details of a specific cloud backup export job for a project and cluster using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports jobs describe Return one cloud backup export job for your project, cluster and job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-exports-jobs-list.txt b/source/command/atlas-backups-exports-jobs-list.txt index 6c201db9..8da9bbac 100644 --- a/source/command/atlas-backups-exports-jobs-list.txt +++ b/source/command/atlas-backups-exports-jobs-list.txt @@ -4,9 +4,6 @@ atlas backups exports jobs list =============================== -.. meta:: - :description: List all cloud backup export jobs for a specified Atlas cluster using the CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports jobs list Return all cloud backup export jobs for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-exports-jobs-watch.txt b/source/command/atlas-backups-exports-jobs-watch.txt index a352310c..317270b0 100644 --- a/source/command/atlas-backups-exports-jobs-watch.txt +++ b/source/command/atlas-backups-exports-jobs-watch.txt @@ -4,9 +4,6 @@ atlas backups exports jobs watch ================================ -.. meta:: - :description: Monitor the status of an export job in Atlas until it completes, fails, or is canceled, using the CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups exports jobs watch Watch for the specified export job to complete. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the export job's status periodically until it reaches a completed, cancelled or failed status. Once the export reaches the expected status, the command prints "Export completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/source/command/atlas-backups-exports-jobs.txt b/source/command/atlas-backups-exports-jobs.txt index 18641dd1..15fedcab 100644 --- a/source/command/atlas-backups-exports-jobs.txt +++ b/source/command/atlas-backups-exports-jobs.txt @@ -14,6 +14,13 @@ atlas backups exports jobs Manage cloud backup export jobs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-exports.txt b/source/command/atlas-backups-exports.txt index 1038c8c8..8053b20f 100644 --- a/source/command/atlas-backups-exports.txt +++ b/source/command/atlas-backups-exports.txt @@ -14,6 +14,13 @@ atlas backups exports Manage cloud backup export jobs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-restores-describe.txt b/source/command/atlas-backups-restores-describe.txt index fc83a4b1..3108c97b 100644 --- a/source/command/atlas-backups-restores-describe.txt +++ b/source/command/atlas-backups-restores-describe.txt @@ -4,9 +4,6 @@ atlas backups restores describe =============================== -.. meta:: - :description: Describe a cloud backup restore job using the Atlas CLI with options for cluster name, output format, and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups restores describe Describe a cloud backup restore job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-restores-list.txt b/source/command/atlas-backups-restores-list.txt index dbbd1f4d..11a1b791 100644 --- a/source/command/atlas-backups-restores-list.txt +++ b/source/command/atlas-backups-restores-list.txt @@ -14,6 +14,11 @@ atlas backups restores list Return all cloud backup restore jobs for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-restores-start.txt b/source/command/atlas-backups-restores-start.txt index 5013a092..8879525a 100644 --- a/source/command/atlas-backups-restores-start.txt +++ b/source/command/atlas-backups-restores-start.txt @@ -14,6 +14,11 @@ atlas backups restores start Start a restore job for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-backups-restores-watch.txt b/source/command/atlas-backups-restores-watch.txt index 62e91e94..6debf82c 100644 --- a/source/command/atlas-backups-restores-watch.txt +++ b/source/command/atlas-backups-restores-watch.txt @@ -4,9 +4,6 @@ atlas backups restores watch ============================ -.. meta:: - :description: Monitor the status of a restore job in Atlas until it completes, fails, or is canceled, using the `atlas backups restores watch` command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups restores watch Watch for a restore job to complete. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. Once the restore reaches the expected status, the command prints "Restore completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/source/command/atlas-backups-restores.txt b/source/command/atlas-backups-restores.txt index 099d8738..fda2b83f 100644 --- a/source/command/atlas-backups-restores.txt +++ b/source/command/atlas-backups-restores.txt @@ -4,9 +4,6 @@ atlas backups restores ====================== -.. meta:: - :description: Manage cloud backup restore jobs for your project using various commands to describe, list, start, and watch restore jobs. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas backups restores Manage cloud backup restore jobs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-schedule-delete.txt b/source/command/atlas-backups-schedule-delete.txt index 7118a2cf..7b9a5ac4 100644 --- a/source/command/atlas-backups-schedule-delete.txt +++ b/source/command/atlas-backups-schedule-delete.txt @@ -4,9 +4,6 @@ atlas backups schedule delete ============================= -.. meta:: - :description: Delete all backup schedules for a specified cluster using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups schedule delete Delete all backup schedules of a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-backups-schedule-describe.txt b/source/command/atlas-backups-schedule-describe.txt index ae4d063e..08539850 100644 --- a/source/command/atlas-backups-schedule-describe.txt +++ b/source/command/atlas-backups-schedule-describe.txt @@ -4,9 +4,6 @@ atlas backups schedule describe =============================== -.. meta:: - :description: Describe a cloud backup schedule for a specified cluster using the Atlas CLI command with options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups schedule describe Describe a cloud backup schedule for the cluster you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-backups-schedule-update.txt b/source/command/atlas-backups-schedule-update.txt index ca39dd74..86211468 100644 --- a/source/command/atlas-backups-schedule-update.txt +++ b/source/command/atlas-backups-schedule-update.txt @@ -4,9 +4,6 @@ atlas backups schedule update ============================= -.. meta:: - :description: Modify the backup schedule for a specified cluster in your project, defining snapshot timing and retention duration. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups schedule update Modify the backup schedule for the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The backup schedule defines when MongoDB takes scheduled snapshots and how long it stores those snapshots. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-backups-schedule.txt b/source/command/atlas-backups-schedule.txt index 3b338224..8af337ba 100644 --- a/source/command/atlas-backups-schedule.txt +++ b/source/command/atlas-backups-schedule.txt @@ -14,6 +14,13 @@ atlas backups schedule Return a cloud backup schedule for the cluster you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups-snapshots-create.txt b/source/command/atlas-backups-snapshots-create.txt index bb405f77..4a2f8131 100644 --- a/source/command/atlas-backups-snapshots-create.txt +++ b/source/command/atlas-backups-snapshots-create.txt @@ -4,9 +4,6 @@ atlas backups snapshots create ============================== -.. meta:: - :description: Create on-demand backup snapshots for Atlas clusters M10 and larger using the CLI command with various options for customization. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas backups snapshots create Create a backup snapshot for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can create on-demand backup snapshots for Atlas cluster tiers M10 and larger. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-backups-snapshots-delete.txt b/source/command/atlas-backups-snapshots-delete.txt index 99e44b55..05c247aa 100644 --- a/source/command/atlas-backups-snapshots-delete.txt +++ b/source/command/atlas-backups-snapshots-delete.txt @@ -14,6 +14,11 @@ atlas backups snapshots delete Remove the specified backup snapshot. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Atlas supports this command only for M10+ clusters. diff --git a/source/command/atlas-backups-snapshots-describe.txt b/source/command/atlas-backups-snapshots-describe.txt index 20bcc9f6..794c70b8 100644 --- a/source/command/atlas-backups-snapshots-describe.txt +++ b/source/command/atlas-backups-snapshots-describe.txt @@ -14,6 +14,11 @@ atlas backups snapshots describe Return the details for the specified snapshot for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-backups-snapshots-download.txt b/source/command/atlas-backups-snapshots-download.txt index 11b570f9..0d18b8aa 100644 --- a/source/command/atlas-backups-snapshots-download.txt +++ b/source/command/atlas-backups-snapshots-download.txt @@ -14,6 +14,11 @@ atlas backups snapshots download Download one snapshot for the specified flex cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can download a snapshot for an Atlas Flex cluster. To use this command, you must authenticate with a user account or an API key with the Project Owner role. Atlas supports this command only for Flex clusters. diff --git a/source/command/atlas-backups-snapshots-list.txt b/source/command/atlas-backups-snapshots-list.txt index 4fee8008..ab98629b 100644 --- a/source/command/atlas-backups-snapshots-list.txt +++ b/source/command/atlas-backups-snapshots-list.txt @@ -14,6 +14,11 @@ atlas backups snapshots list Return all cloud backup snapshots for your project and cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-backups-snapshots-watch.txt b/source/command/atlas-backups-snapshots-watch.txt index f17ed235..65a3a2e5 100644 --- a/source/command/atlas-backups-snapshots-watch.txt +++ b/source/command/atlas-backups-snapshots-watch.txt @@ -14,6 +14,11 @@ atlas backups snapshots watch Watch the specified snapshot in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the snapshot's status periodically until it reaches a completed or failed status. Once the snapshot reaches the expected status, the command prints "Snapshot changes completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/source/command/atlas-backups-snapshots.txt b/source/command/atlas-backups-snapshots.txt index 028c6c02..8ccde5d6 100644 --- a/source/command/atlas-backups-snapshots.txt +++ b/source/command/atlas-backups-snapshots.txt @@ -14,6 +14,13 @@ atlas backups snapshots Manage cloud backup snapshots for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-backups.txt b/source/command/atlas-backups.txt index 4009fff0..b02fa017 100644 --- a/source/command/atlas-backups.txt +++ b/source/command/atlas-backups.txt @@ -4,9 +4,6 @@ atlas backups ============= -.. meta:: - :description: Manage cloud backups for your project using various Atlas CLI commands and options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas backups Manage cloud backups for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt b/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt index 63807f8d..9e67b1db 100644 --- a/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt +++ b/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles aws authorize Authorize an AWS IAM role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-cloudProviders-accessRoles-aws-create.txt b/source/command/atlas-cloudProviders-accessRoles-aws-create.txt index d9d9cc95..daa56658 100644 --- a/source/command/atlas-cloudProviders-accessRoles-aws-create.txt +++ b/source/command/atlas-cloudProviders-accessRoles-aws-create.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles aws create Create an AWS IAM role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt b/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt index cdb6f3e2..5b891c2c 100644 --- a/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt +++ b/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles aws deauthorize Deauthorize an AWS IAM role. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-cloudProviders-accessRoles-aws.txt b/source/command/atlas-cloudProviders-accessRoles-aws.txt index 87be4ff4..136a9d0d 100644 --- a/source/command/atlas-cloudProviders-accessRoles-aws.txt +++ b/source/command/atlas-cloudProviders-accessRoles-aws.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles aws Manage AWS IAM role access in Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-cloudProviders-accessRoles-list.txt b/source/command/atlas-cloudProviders-accessRoles-list.txt index f547b542..e21673a1 100644 --- a/source/command/atlas-cloudProviders-accessRoles-list.txt +++ b/source/command/atlas-cloudProviders-accessRoles-list.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles list List AWS IAM role access in Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-cloudProviders-accessRoles.txt b/source/command/atlas-cloudProviders-accessRoles.txt index a0d5c04f..8a932a5b 100644 --- a/source/command/atlas-cloudProviders-accessRoles.txt +++ b/source/command/atlas-cloudProviders-accessRoles.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles Manage AWS IAM role access in Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-cloudProviders.txt b/source/command/atlas-cloudProviders.txt index 8db8e783..36918900 100644 --- a/source/command/atlas-cloudProviders.txt +++ b/source/command/atlas-cloudProviders.txt @@ -4,9 +4,6 @@ atlas cloudProviders ==================== -.. meta:: - :description: Manage cloud provider access in Atlas using AWS IAM roles with the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas cloudProviders Manage cloud provider access in Atlas using AWS IAM roles. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-advancedSettings-describe.txt b/source/command/atlas-clusters-advancedSettings-describe.txt index 0198f5cf..a799377a 100644 --- a/source/command/atlas-clusters-advancedSettings-describe.txt +++ b/source/command/atlas-clusters-advancedSettings-describe.txt @@ -4,9 +4,6 @@ atlas clusters advancedSettings describe ======================================== -.. meta:: - :description: Retrieve advanced configuration settings for a specified Atlas cluster using the CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters advancedSettings describe Retrieve advanced configuration settings for one cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-advancedSettings-update.txt b/source/command/atlas-clusters-advancedSettings-update.txt index eb48acad..39f245aa 100644 --- a/source/command/atlas-clusters-advancedSettings-update.txt +++ b/source/command/atlas-clusters-advancedSettings-update.txt @@ -4,9 +4,6 @@ atlas clusters advancedSettings update ====================================== -.. meta:: - :description: Update advanced configuration settings for a cluster in a specified project, including read/write concern, index limits, and oplog settings, for M10+ clusters. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters advancedSettings update Update advanced configuration settings for one cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. Atlas supports this command only for M10+ clusters. diff --git a/source/command/atlas-clusters-advancedSettings.txt b/source/command/atlas-clusters-advancedSettings.txt index 206c7620..e88b76fd 100644 --- a/source/command/atlas-clusters-advancedSettings.txt +++ b/source/command/atlas-clusters-advancedSettings.txt @@ -14,6 +14,13 @@ atlas clusters advancedSettings Manage advanced configuration settings for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-availableRegions-list.txt b/source/command/atlas-clusters-availableRegions-list.txt index 84c1d941..6443c0e9 100644 --- a/source/command/atlas-clusters-availableRegions-list.txt +++ b/source/command/atlas-clusters-availableRegions-list.txt @@ -4,9 +4,6 @@ atlas clusters availableRegions list ==================================== -.. meta:: - :description: List available regions for new Atlas deployments using the CLI, with options for provider, tier, and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas clusters availableRegions list List available regions that Atlas supports for new deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-clusters-availableRegions.txt b/source/command/atlas-clusters-availableRegions.txt index 56a43e7f..659e4cd7 100644 --- a/source/command/atlas-clusters-availableRegions.txt +++ b/source/command/atlas-clusters-availableRegions.txt @@ -14,6 +14,13 @@ atlas clusters availableRegions Manage available regions for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-connectionStrings-describe.txt b/source/command/atlas-clusters-connectionStrings-describe.txt index 0220cf30..434c26ca 100644 --- a/source/command/atlas-clusters-connectionStrings-describe.txt +++ b/source/command/atlas-clusters-connectionStrings-describe.txt @@ -4,9 +4,6 @@ atlas clusters connectionStrings describe ========================================= -.. meta:: - :description: Retrieve the SRV connection string for a specified Atlas cluster using the CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters connectionStrings describe Return the SRV connection string for the cluster you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-connectionStrings.txt b/source/command/atlas-clusters-connectionStrings.txt index 0b206d8b..beaeeb8c 100644 --- a/source/command/atlas-clusters-connectionStrings.txt +++ b/source/command/atlas-clusters-connectionStrings.txt @@ -14,6 +14,13 @@ atlas clusters connectionStrings Manage MongoDB cluster connection string. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-create.txt b/source/command/atlas-clusters-create.txt index 8dcf9156..5e274f57 100644 --- a/source/command/atlas-clusters-create.txt +++ b/source/command/atlas-clusters-create.txt @@ -4,9 +4,6 @@ atlas clusters create ===================== -.. meta:: - :description: Create a cluster in Atlas by specifying a name, cloud provider, and region, or use a JSON configuration file for detailed settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters create Create a cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version. For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag. diff --git a/source/command/atlas-clusters-delete.txt b/source/command/atlas-clusters-delete.txt index 213c1d8b..ea1199aa 100644 --- a/source/command/atlas-clusters-delete.txt +++ b/source/command/atlas-clusters-delete.txt @@ -4,9 +4,6 @@ atlas clusters delete ===================== -.. meta:: - :description: Delete a specified cluster from your project using the Atlas CLI, with options for confirmation prompts and backup snapshot removal. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters delete Remove the specified cluster from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Deleting a cluster also deletes any backup snapshots for that cluster. diff --git a/source/command/atlas-clusters-describe.txt b/source/command/atlas-clusters-describe.txt index fae71df1..22e5e244 100644 --- a/source/command/atlas-clusters-describe.txt +++ b/source/command/atlas-clusters-describe.txt @@ -4,9 +4,6 @@ atlas clusters describe ======================= -.. meta:: - :description: Retrieve details of a specified cluster using the Atlas CLI, with options for output format and project identification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters describe Return the details for the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-failover.txt b/source/command/atlas-clusters-failover.txt index bdb24cb6..cac04720 100644 --- a/source/command/atlas-clusters-failover.txt +++ b/source/command/atlas-clusters-failover.txt @@ -4,9 +4,6 @@ atlas clusters failover ======================= -.. meta:: - :description: Initiate a failover test for a specified cluster in a project using the Atlas CLI, which involves shutting down the primary node and electing a new one. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters failover Starts a failover test for the specified cluster in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. Syntax diff --git a/source/command/atlas-clusters-indexes-create.txt b/source/command/atlas-clusters-indexes-create.txt index 3a8edca6..3b73e401 100644 --- a/source/command/atlas-clusters-indexes-create.txt +++ b/source/command/atlas-clusters-indexes-create.txt @@ -4,9 +4,6 @@ atlas clusters indexes create ============================= -.. meta:: - :description: Create a rolling index for a specified cluster using the Atlas CLI, with options for cluster name, collection, database, and index configuration. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters indexes create Create a rolling index for the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-indexes.txt b/source/command/atlas-clusters-indexes.txt index 2fb07225..0b908df2 100644 --- a/source/command/atlas-clusters-indexes.txt +++ b/source/command/atlas-clusters-indexes.txt @@ -14,6 +14,13 @@ atlas clusters indexes Manage cluster rolling indexes for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-list.txt b/source/command/atlas-clusters-list.txt index 274c1ef1..d40af988 100644 --- a/source/command/atlas-clusters-list.txt +++ b/source/command/atlas-clusters-list.txt @@ -4,9 +4,6 @@ atlas clusters list =================== -.. meta:: - :description: List all clusters in your project using the Atlas CLI, with options for output format, pagination, and project specification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters list Return all clusters for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-create.txt b/source/command/atlas-clusters-onlineArchives-create.txt index 8c7a707e..b7d4e6b1 100644 --- a/source/command/atlas-clusters-onlineArchives-create.txt +++ b/source/command/atlas-clusters-onlineArchives-create.txt @@ -4,9 +4,6 @@ atlas clusters onlineArchives create ==================================== -.. meta:: - :description: Create an online archive for a collection in a specified cluster using the Atlas CLI, with options for configuration and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters onlineArchives create Create an online archive for a collection in the specified cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can create an online archive for an M10 or larger cluster. To learn more about online archives, see https://www.mongodb.com/docs/atlas/online-archive/manage-online-archive/. diff --git a/source/command/atlas-clusters-onlineArchives-delete.txt b/source/command/atlas-clusters-onlineArchives-delete.txt index 1565262d..1e270f0d 100644 --- a/source/command/atlas-clusters-onlineArchives-delete.txt +++ b/source/command/atlas-clusters-onlineArchives-delete.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives delete Remove the specified online archive from your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-describe.txt b/source/command/atlas-clusters-onlineArchives-describe.txt index 61d98b1a..b367a735 100644 --- a/source/command/atlas-clusters-onlineArchives-describe.txt +++ b/source/command/atlas-clusters-onlineArchives-describe.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives describe Return the details for the specified online archive for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-list.txt b/source/command/atlas-clusters-onlineArchives-list.txt index 31303c36..c431fd59 100644 --- a/source/command/atlas-clusters-onlineArchives-list.txt +++ b/source/command/atlas-clusters-onlineArchives-list.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives list Return all online archives for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-pause.txt b/source/command/atlas-clusters-onlineArchives-pause.txt index 996bf976..20b2332f 100644 --- a/source/command/atlas-clusters-onlineArchives-pause.txt +++ b/source/command/atlas-clusters-onlineArchives-pause.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives pause Pause the specfied online archive for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-start.txt b/source/command/atlas-clusters-onlineArchives-start.txt index 9b9f22ef..edfaca78 100644 --- a/source/command/atlas-clusters-onlineArchives-start.txt +++ b/source/command/atlas-clusters-onlineArchives-start.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives start Start a paused online archive from a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-update.txt b/source/command/atlas-clusters-onlineArchives-update.txt index 9a696414..6e147f2b 100644 --- a/source/command/atlas-clusters-onlineArchives-update.txt +++ b/source/command/atlas-clusters-onlineArchives-update.txt @@ -4,9 +4,6 @@ atlas clusters onlineArchives update ==================================== -.. meta:: - :description: Update the archiving rule for an online archive in a cluster using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters onlineArchives update Modify the archiving rule for the specified online archive for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-onlineArchives-watch.txt b/source/command/atlas-clusters-onlineArchives-watch.txt index dd7d0162..0978c01c 100644 --- a/source/command/atlas-clusters-onlineArchives-watch.txt +++ b/source/command/atlas-clusters-onlineArchives-watch.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives watch Watch for an archive to be available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. Once the archive reaches the expected status, the command prints "Online archive available." If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. diff --git a/source/command/atlas-clusters-onlineArchives.txt b/source/command/atlas-clusters-onlineArchives.txt index b689acf5..bd566ac1 100644 --- a/source/command/atlas-clusters-onlineArchives.txt +++ b/source/command/atlas-clusters-onlineArchives.txt @@ -14,6 +14,13 @@ atlas clusters onlineArchives Manage online archives for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-pause.txt b/source/command/atlas-clusters-pause.txt index 98c83ac9..9ee26227 100644 --- a/source/command/atlas-clusters-pause.txt +++ b/source/command/atlas-clusters-pause.txt @@ -4,9 +4,6 @@ atlas clusters pause ==================== -.. meta:: - :description: Pause a running cluster in Atlas using the CLI, requiring authentication and applicable to M10+ clusters. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters pause Pause the specified running MongoDB cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters. diff --git a/source/command/atlas-clusters-sampleData-describe.txt b/source/command/atlas-clusters-sampleData-describe.txt index a4e16432..29b6c531 100644 --- a/source/command/atlas-clusters-sampleData-describe.txt +++ b/source/command/atlas-clusters-sampleData-describe.txt @@ -4,9 +4,6 @@ atlas clusters sampleData describe ================================== -.. meta:: - :description: Retrieve details of a sample data load job using the Atlas CLI command with specified options for output format and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters sampleData describe Return the details for the specified sample data load job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-sampleData-load.txt b/source/command/atlas-clusters-sampleData-load.txt index 9bac2d5f..bec2a5b6 100644 --- a/source/command/atlas-clusters-sampleData-load.txt +++ b/source/command/atlas-clusters-sampleData-load.txt @@ -4,9 +4,6 @@ atlas clusters sampleData load ============================== -.. meta:: - :description: Load sample data into a specified Atlas cluster using the CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters sampleData load Load sample data into the specified cluster for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-clusters-sampleData-watch.txt b/source/command/atlas-clusters-sampleData-watch.txt index b8808c5e..5546b53d 100644 --- a/source/command/atlas-clusters-sampleData-watch.txt +++ b/source/command/atlas-clusters-sampleData-watch.txt @@ -4,9 +4,6 @@ atlas clusters sampleData watch =============================== -.. meta:: - :description: Monitor the status of a sample data job in your cluster until it completes using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters sampleData watch Watch the specified sample data job in your cluster until it completes. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the sample data job's status periodically until it reaches an COMPLETED state. If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. You can interrupt the command's polling at any time with CTRL-C. diff --git a/source/command/atlas-clusters-sampleData.txt b/source/command/atlas-clusters-sampleData.txt index a848c8b1..1b8dedeb 100644 --- a/source/command/atlas-clusters-sampleData.txt +++ b/source/command/atlas-clusters-sampleData.txt @@ -4,9 +4,6 @@ atlas clusters sampleData ========================= -.. meta:: - :description: Access and manage sample data for your cluster using the sampleData command in the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters sampleData Manage sample data for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The sampleData command provides access to sample data to be loaded onto your cluster. Options diff --git a/source/command/atlas-clusters-search-indexes-create.txt b/source/command/atlas-clusters-search-indexes-create.txt index f305ccfd..b33966e2 100644 --- a/source/command/atlas-clusters-search-indexes-create.txt +++ b/source/command/atlas-clusters-search-indexes-create.txt @@ -4,9 +4,6 @@ atlas clusters search indexes create ==================================== -.. meta:: - :description: Create a search index for a cluster using the Atlas CLI, specifying options like cluster name and index configuration file. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search indexes create Create a search index for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-search-indexes-delete.txt b/source/command/atlas-clusters-search-indexes-delete.txt index 7541ce10..f25f528d 100644 --- a/source/command/atlas-clusters-search-indexes-delete.txt +++ b/source/command/atlas-clusters-search-indexes-delete.txt @@ -14,6 +14,11 @@ atlas clusters search indexes delete Delete the specified search index from the specified cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-search-indexes-describe.txt b/source/command/atlas-clusters-search-indexes-describe.txt index fa3ef828..d517a5a8 100644 --- a/source/command/atlas-clusters-search-indexes-describe.txt +++ b/source/command/atlas-clusters-search-indexes-describe.txt @@ -4,9 +4,6 @@ atlas clusters search indexes describe ====================================== -.. meta:: - :description: Retrieve details of a search index for a cluster using the Atlas CLI, requiring authentication and specifying the index ID and cluster name. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search indexes describe Return the details for the search index for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/source/command/atlas-clusters-search-indexes-list.txt b/source/command/atlas-clusters-search-indexes-list.txt index 0a899056..b0f4e58a 100644 --- a/source/command/atlas-clusters-search-indexes-list.txt +++ b/source/command/atlas-clusters-search-indexes-list.txt @@ -4,9 +4,6 @@ atlas clusters search indexes list ================================== -.. meta:: - :description: List all Atlas Search indexes for a cluster using the Atlas CLI, specifying cluster, database, and collection names. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search indexes list List all Atlas Search indexes for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/source/command/atlas-clusters-search-indexes-update.txt b/source/command/atlas-clusters-search-indexes-update.txt index 87c5a17d..e3edfec2 100644 --- a/source/command/atlas-clusters-search-indexes-update.txt +++ b/source/command/atlas-clusters-search-indexes-update.txt @@ -14,6 +14,11 @@ atlas clusters search indexes update Modify a search index for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/source/command/atlas-clusters-search-indexes.txt b/source/command/atlas-clusters-search-indexes.txt index 160e6796..df172b14 100644 --- a/source/command/atlas-clusters-search-indexes.txt +++ b/source/command/atlas-clusters-search-indexes.txt @@ -14,6 +14,13 @@ atlas clusters search indexes Manage Atlas Search indexes for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-search-nodes-create.txt b/source/command/atlas-clusters-search-nodes-create.txt index 74416ee4..51cf4881 100644 --- a/source/command/atlas-clusters-search-nodes-create.txt +++ b/source/command/atlas-clusters-search-nodes-create.txt @@ -4,9 +4,6 @@ atlas clusters search nodes create ================================== -.. meta:: - :description: Create a search node for a cluster using the Atlas CLI, requiring authentication and specifying options like cluster name and configuration file. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search nodes create Create a search node for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/source/command/atlas-clusters-search-nodes-delete.txt b/source/command/atlas-clusters-search-nodes-delete.txt index 95fe6080..5666a209 100644 --- a/source/command/atlas-clusters-search-nodes-delete.txt +++ b/source/command/atlas-clusters-search-nodes-delete.txt @@ -4,9 +4,6 @@ atlas clusters search nodes delete ================================== -.. meta:: - :description: Delete a search node from a cluster using the Atlas CLI, requiring authentication and cluster name specification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search nodes delete Delete a search node for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/source/command/atlas-clusters-search-nodes-list.txt b/source/command/atlas-clusters-search-nodes-list.txt index 2f896a7d..4c2c8175 100644 --- a/source/command/atlas-clusters-search-nodes-list.txt +++ b/source/command/atlas-clusters-search-nodes-list.txt @@ -4,9 +4,6 @@ atlas clusters search nodes list ================================ -.. meta:: - :description: List Atlas Search nodes for a cluster using the CLI, requiring authentication and specifying cluster name and output format options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search nodes list List all Atlas Search nodes for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-clusters-search-nodes-update.txt b/source/command/atlas-clusters-search-nodes-update.txt index 6fe83872..4d1f31d8 100644 --- a/source/command/atlas-clusters-search-nodes-update.txt +++ b/source/command/atlas-clusters-search-nodes-update.txt @@ -4,9 +4,6 @@ atlas clusters search nodes update ================================== -.. meta:: - :description: Update a search node for a cluster using the Atlas CLI with options for cluster name, configuration file, and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters search nodes update Update a search node for a cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/source/command/atlas-clusters-search-nodes.txt b/source/command/atlas-clusters-search-nodes.txt index 958a0897..15c24973 100644 --- a/source/command/atlas-clusters-search-nodes.txt +++ b/source/command/atlas-clusters-search-nodes.txt @@ -14,6 +14,13 @@ atlas clusters search nodes Manage Atlas Search nodes for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-search.txt b/source/command/atlas-clusters-search.txt index 9f636d47..0cf13ee0 100644 --- a/source/command/atlas-clusters-search.txt +++ b/source/command/atlas-clusters-search.txt @@ -4,9 +4,6 @@ atlas clusters search ===================== -.. meta:: - :description: Manage Atlas Search for your cluster using the Atlas CLI with options for help and profile configuration. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas clusters search Manage Atlas Search for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-clusters-start.txt b/source/command/atlas-clusters-start.txt index 039a77aa..785cfb5f 100644 --- a/source/command/atlas-clusters-start.txt +++ b/source/command/atlas-clusters-start.txt @@ -4,9 +4,6 @@ atlas clusters start ==================== -.. meta:: - :description: Start a paused MongoDB cluster using the Atlas CLI, requiring authentication and supporting M10+ clusters. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters start Start the specified paused MongoDB cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters. diff --git a/source/command/atlas-clusters-update.txt b/source/command/atlas-clusters-update.txt index 05edae0f..2f286682 100644 --- a/source/command/atlas-clusters-update.txt +++ b/source/command/atlas-clusters-update.txt @@ -4,9 +4,6 @@ atlas clusters update ===================== -.. meta:: - :description: Modify cluster settings using the Atlas CLI, with options for JSON configuration files, tier updates, and termination protection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters update Modify the settings of the specified cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can specify modifications in a JSON configuration file with the --file flag. You can't change the name of the cluster or downgrade the MongoDB version of your cluster. diff --git a/source/command/atlas-clusters-upgrade.txt b/source/command/atlas-clusters-upgrade.txt index c0a6836f..5e8a3308 100644 --- a/source/command/atlas-clusters-upgrade.txt +++ b/source/command/atlas-clusters-upgrade.txt @@ -4,9 +4,6 @@ atlas clusters upgrade ====================== -.. meta:: - :description: Upgrade a shared cluster's tier, disk size, or MongoDB version using the Atlas CLI, with options for termination protection and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters upgrade Upgrade a shared cluster's tier, disk size, and/or MongoDB version. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command is unavailable for dedicated clusters. To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. diff --git a/source/command/atlas-clusters-watch.txt b/source/command/atlas-clusters-watch.txt index d6a03b93..d5fd242d 100644 --- a/source/command/atlas-clusters-watch.txt +++ b/source/command/atlas-clusters-watch.txt @@ -4,9 +4,6 @@ atlas clusters watch ==================== -.. meta:: - :description: Monitor a specified cluster's status until it becomes available using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters watch Watch the specified cluster in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the cluster's status periodically until it reaches an IDLE state. Once the cluster reaches the expected state, the command prints "Cluster available." If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. diff --git a/source/command/atlas-clusters.txt b/source/command/atlas-clusters.txt index 871df3ee..89808027 100644 --- a/source/command/atlas-clusters.txt +++ b/source/command/atlas-clusters.txt @@ -4,9 +4,6 @@ atlas clusters ============== -.. meta:: - :description: Manage and configure clusters in your project using the Atlas CLI, including creating, editing, and deleting clusters. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas clusters Manage clusters for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters. Options diff --git a/source/command/atlas-completion-bash.txt b/source/command/atlas-completion-bash.txt index 46b3f506..14d36aab 100644 --- a/source/command/atlas-completion-bash.txt +++ b/source/command/atlas-completion-bash.txt @@ -4,9 +4,6 @@ atlas completion bash ===================== -.. meta:: - :description: Generate a bash autocompletion script for Atlas CLI, requiring the 'bash-completion' package and providing options for setup. - .. default-domain:: mongodb .. contents:: On this page diff --git a/source/command/atlas-completion-fish.txt b/source/command/atlas-completion-fish.txt index cdb18085..88493a24 100644 --- a/source/command/atlas-completion-fish.txt +++ b/source/command/atlas-completion-fish.txt @@ -14,6 +14,11 @@ atlas completion fish Generate the autocompletion script for fish +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for the fish shell. To load completions in your current shell session: diff --git a/source/command/atlas-completion-powershell.txt b/source/command/atlas-completion-powershell.txt index 4ec9d22b..92864e69 100644 --- a/source/command/atlas-completion-powershell.txt +++ b/source/command/atlas-completion-powershell.txt @@ -14,6 +14,11 @@ atlas completion powershell Generate the autocompletion script for powershell +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for powershell. To load completions in your current shell session: diff --git a/source/command/atlas-completion-zsh.txt b/source/command/atlas-completion-zsh.txt index f5052fa5..39ddc5fb 100644 --- a/source/command/atlas-completion-zsh.txt +++ b/source/command/atlas-completion-zsh.txt @@ -14,6 +14,11 @@ atlas completion zsh Generate the autocompletion script for zsh +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for the zsh shell. If shell completion is not already enabled in your environment you will need diff --git a/source/command/atlas-completion.txt b/source/command/atlas-completion.txt index 7fad5464..8ae0cc0b 100644 --- a/source/command/atlas-completion.txt +++ b/source/command/atlas-completion.txt @@ -4,9 +4,6 @@ atlas completion ================ -.. meta:: - :description: Generate autocompletion scripts for Atlas CLI in various shells, including bash, fish, powershell, and zsh. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas completion Generate the autocompletion script for the specified shell +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Generate the autocompletion script for atlas for the specified shell. See each sub-command's help for details on how to use the generated script. diff --git a/source/command/atlas-config-delete.txt b/source/command/atlas-config-delete.txt index 767cc099..37d961a1 100644 --- a/source/command/atlas-config-delete.txt +++ b/source/command/atlas-config-delete.txt @@ -14,6 +14,13 @@ atlas config delete Delete a profile. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-config-describe.txt b/source/command/atlas-config-describe.txt index 1b8d013b..b1911dcf 100644 --- a/source/command/atlas-config-describe.txt +++ b/source/command/atlas-config-describe.txt @@ -4,9 +4,6 @@ atlas config describe ===================== -.. meta:: - :description: Retrieve a specified profile using the "atlas config describe" command with options for output format and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas config describe Return the profile you specify. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-config-edit.txt b/source/command/atlas-config-edit.txt index 880f8f54..ec1478b0 100644 --- a/source/command/atlas-config-edit.txt +++ b/source/command/atlas-config-edit.txt @@ -4,9 +4,6 @@ atlas config edit ================= -.. meta:: - :description: Open the Atlas CLI config file using the default text editor, with options to change the editor via environment variables. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas config edit Opens the config file with the default text editor. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default. Syntax diff --git a/source/command/atlas-config-init.txt b/source/command/atlas-config-init.txt index a9074d51..8f191859 100644 --- a/source/command/atlas-config-init.txt +++ b/source/command/atlas-config-init.txt @@ -4,9 +4,6 @@ atlas config init ================= -.. meta:: - :description: Configure a profile to store access settings for your MongoDB deployment using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas config init Configure a profile to store access settings for your MongoDB deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-config-list.txt b/source/command/atlas-config-list.txt index 2f1a7520..f4d33793 100644 --- a/source/command/atlas-config-list.txt +++ b/source/command/atlas-config-list.txt @@ -4,9 +4,6 @@ atlas config list ================= -.. meta:: - :description: List available profiles by name using the Atlas CLI, with options for output format and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas config list Return a list of available profiles by name. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + If you did not specify a name for your profile, it displays as the default profile. Syntax diff --git a/source/command/atlas-config-rename.txt b/source/command/atlas-config-rename.txt index cd801e52..f0ab398a 100644 --- a/source/command/atlas-config-rename.txt +++ b/source/command/atlas-config-rename.txt @@ -14,6 +14,13 @@ atlas config rename Rename a profile. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-config-set.txt b/source/command/atlas-config-set.txt index dd1be889..b2bf1ec5 100644 --- a/source/command/atlas-config-set.txt +++ b/source/command/atlas-config-set.txt @@ -14,6 +14,13 @@ atlas config set Configure specific properties of a profile. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-config.txt b/source/command/atlas-config.txt index b1b9d49a..14f6b198 100644 --- a/source/command/atlas-config.txt +++ b/source/command/atlas-config.txt @@ -4,9 +4,6 @@ atlas config ============ -.. meta:: - :description: Manage and configure user profiles in Atlas CLI, including setting options and using environment variables. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas config Configure and manage your user profiles. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Configure settings in a user profile. All settings are optional. You can specify settings individually by running: $ atlas config set --help diff --git a/source/command/atlas-customDbRoles-create.txt b/source/command/atlas-customDbRoles-create.txt index 9b9a0e32..1e5ab98d 100644 --- a/source/command/atlas-customDbRoles-create.txt +++ b/source/command/atlas-customDbRoles-create.txt @@ -4,9 +4,6 @@ atlas customDbRoles create ========================== -.. meta:: - :description: Create a custom database role in your project using the Atlas CLI, specifying role name, privileges, and optional inherited roles. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas customDbRoles create Create a custom database role for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-customDbRoles-delete.txt b/source/command/atlas-customDbRoles-delete.txt index 7eb58850..eba3c574 100644 --- a/source/command/atlas-customDbRoles-delete.txt +++ b/source/command/atlas-customDbRoles-delete.txt @@ -4,9 +4,6 @@ atlas customDbRoles delete ========================== -.. meta:: - :description: Remove a custom database role from your Atlas project using the CLI command with options for force and project ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas customDbRoles delete Remove the specified custom database role from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-customDbRoles-describe.txt b/source/command/atlas-customDbRoles-describe.txt index b0a09e86..10cae215 100644 --- a/source/command/atlas-customDbRoles-describe.txt +++ b/source/command/atlas-customDbRoles-describe.txt @@ -4,9 +4,6 @@ atlas customDbRoles describe ============================ -.. meta:: - :description: Retrieve details of a custom database role in your project using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas customDbRoles describe Return a single custom database role for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-customDbRoles-list.txt b/source/command/atlas-customDbRoles-list.txt index b3eae042..8e256bf7 100644 --- a/source/command/atlas-customDbRoles-list.txt +++ b/source/command/atlas-customDbRoles-list.txt @@ -4,9 +4,6 @@ atlas customDbRoles list ======================== -.. meta:: - :description: List custom database roles for your project using the Atlas CLI command with options for output format and project identification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas customDbRoles list List custom database roles for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-customDbRoles-update.txt b/source/command/atlas-customDbRoles-update.txt index 94e2881d..619ca0f4 100644 --- a/source/command/atlas-customDbRoles-update.txt +++ b/source/command/atlas-customDbRoles-update.txt @@ -4,9 +4,6 @@ atlas customDbRoles update ========================== -.. meta:: - :description: Update a custom database role in your project using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas customDbRoles update Update a custom database role for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-customDbRoles.txt b/source/command/atlas-customDbRoles.txt index cb648c51..ec12e4f5 100644 --- a/source/command/atlas-customDbRoles.txt +++ b/source/command/atlas-customDbRoles.txt @@ -4,9 +4,6 @@ atlas customDbRoles =================== -.. meta:: - :description: Manage custom database roles in your project using the Atlas CLI, including creating, deleting, and updating roles. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas customDbRoles Manage custom database roles for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-customDns-aws-describe.txt b/source/command/atlas-customDns-aws-describe.txt index f19e00ca..d25889d6 100644 --- a/source/command/atlas-customDns-aws-describe.txt +++ b/source/command/atlas-customDns-aws-describe.txt @@ -14,6 +14,11 @@ atlas customDns aws describe Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-customDns-aws-disable.txt b/source/command/atlas-customDns-aws-disable.txt index fe893148..998a037f 100644 --- a/source/command/atlas-customDns-aws-disable.txt +++ b/source/command/atlas-customDns-aws-disable.txt @@ -14,6 +14,11 @@ atlas customDns aws disable Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-customDns-aws-enable.txt b/source/command/atlas-customDns-aws-enable.txt index 7ebf795a..e42dec03 100644 --- a/source/command/atlas-customDns-aws-enable.txt +++ b/source/command/atlas-customDns-aws-enable.txt @@ -14,6 +14,11 @@ atlas customDns aws enable Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-customDns-aws.txt b/source/command/atlas-customDns-aws.txt index 2b385960..7c0ae6f4 100644 --- a/source/command/atlas-customDns-aws.txt +++ b/source/command/atlas-customDns-aws.txt @@ -14,6 +14,13 @@ atlas customDns aws Manage DNS configuration of an Atlas project’s cluster deployed to AWS. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-customDns.txt b/source/command/atlas-customDns.txt index 8e24c536..a1acf0bf 100644 --- a/source/command/atlas-customDns.txt +++ b/source/command/atlas-customDns.txt @@ -4,9 +4,6 @@ atlas customDns =============== -.. meta:: - :description: Manage DNS configuration for Atlas project clusters deployed on AWS using the customDns command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas customDns Manage DNS configuration of Atlas project’s clusters deployed to AWS. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-dataFederation-create.txt b/source/command/atlas-dataFederation-create.txt index 08f84745..d5de6d01 100644 --- a/source/command/atlas-dataFederation-create.txt +++ b/source/command/atlas-dataFederation-create.txt @@ -4,9 +4,6 @@ atlas dataFederation create =========================== -.. meta:: - :description: Create a new Data Federation database using the Atlas CLI with options for AWS role, S3 bucket, and region settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dataFederation create Creates a new Data Federation database. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-delete.txt b/source/command/atlas-dataFederation-delete.txt index e382667a..46080bd3 100644 --- a/source/command/atlas-dataFederation-delete.txt +++ b/source/command/atlas-dataFederation-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation delete Remove the specified data federation database from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-describe.txt b/source/command/atlas-dataFederation-describe.txt index 5499f348..ec1c187e 100644 --- a/source/command/atlas-dataFederation-describe.txt +++ b/source/command/atlas-dataFederation-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation describe Return the details for the specified data federation database for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-list.txt b/source/command/atlas-dataFederation-list.txt index 59c6ee96..e61d582c 100644 --- a/source/command/atlas-dataFederation-list.txt +++ b/source/command/atlas-dataFederation-list.txt @@ -14,6 +14,11 @@ atlas dataFederation list Returns all data federation databases for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-dataFederation-logs.txt b/source/command/atlas-dataFederation-logs.txt index e10987a0..6a780c13 100644 --- a/source/command/atlas-dataFederation-logs.txt +++ b/source/command/atlas-dataFederation-logs.txt @@ -4,9 +4,6 @@ atlas dataFederation logs ========================= -.. meta:: - :description: Retrieve logs for a specified data federation database using the Atlas CLI, requiring authentication with a user account or API key. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dataFederation logs Returns logs of the specified data federation database for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-dataFederation-privateEndpoints-create.txt b/source/command/atlas-dataFederation-privateEndpoints-create.txt index 92cbbefc..3ce4302f 100644 --- a/source/command/atlas-dataFederation-privateEndpoints-create.txt +++ b/source/command/atlas-dataFederation-privateEndpoints-create.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints create Creates a new Data Federation private endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-privateEndpoints-delete.txt b/source/command/atlas-dataFederation-privateEndpoints-delete.txt index b120e763..19b005a7 100644 --- a/source/command/atlas-dataFederation-privateEndpoints-delete.txt +++ b/source/command/atlas-dataFederation-privateEndpoints-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints delete Remove the specified data federation private endpoint from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-privateEndpoints-describe.txt b/source/command/atlas-dataFederation-privateEndpoints-describe.txt index f6c4a322..fb88777c 100644 --- a/source/command/atlas-dataFederation-privateEndpoints-describe.txt +++ b/source/command/atlas-dataFederation-privateEndpoints-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints describe Return the details for the specified data federation private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-privateEndpoints-list.txt b/source/command/atlas-dataFederation-privateEndpoints-list.txt index 11c74755..97514324 100644 --- a/source/command/atlas-dataFederation-privateEndpoints-list.txt +++ b/source/command/atlas-dataFederation-privateEndpoints-list.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints list Returns all data federation private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-dataFederation-privateEndpoints.txt b/source/command/atlas-dataFederation-privateEndpoints.txt index 18ebd770..8648735c 100644 --- a/source/command/atlas-dataFederation-privateEndpoints.txt +++ b/source/command/atlas-dataFederation-privateEndpoints.txt @@ -4,9 +4,6 @@ atlas dataFederation privateEndpoints ===================================== -.. meta:: - :description: Manage Data Federation private endpoints with commands to create, delete, describe, and list endpoints in your project. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas dataFederation privateEndpoints Data federation private endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-dataFederation-queryLimits-create.txt b/source/command/atlas-dataFederation-queryLimits-create.txt index 32effedd..32d7ac26 100644 --- a/source/command/atlas-dataFederation-queryLimits-create.txt +++ b/source/command/atlas-dataFederation-queryLimits-create.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits create ======================================= -.. meta:: - :description: Create a new Data Federation query limit using the Atlas CLI with specified options and arguments. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dataFederation queryLimits create Creates a new Data Federation query limit. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about the query limits, see https://dochub.mongodb.org/core/adf-query-limits.To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-queryLimits-delete.txt b/source/command/atlas-dataFederation-queryLimits-delete.txt index 305427c4..dcb374aa 100644 --- a/source/command/atlas-dataFederation-queryLimits-delete.txt +++ b/source/command/atlas-dataFederation-queryLimits-delete.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits delete ======================================= -.. meta:: - :description: Remove a specified data federation query limit from your project using the Atlas CLI with authentication and necessary options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dataFederation queryLimits delete Remove the specified data federation query limit from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-queryLimits-describe.txt b/source/command/atlas-dataFederation-queryLimits-describe.txt index 5319afc2..ccf46e59 100644 --- a/source/command/atlas-dataFederation-queryLimits-describe.txt +++ b/source/command/atlas-dataFederation-queryLimits-describe.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits describe ========================================= -.. meta:: - :description: Retrieve details of a specified data federation query limit using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dataFederation queryLimits describe Return the details for the specified data federation query limit for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation-queryLimits-list.txt b/source/command/atlas-dataFederation-queryLimits-list.txt index 384dc223..8408b8bf 100644 --- a/source/command/atlas-dataFederation-queryLimits-list.txt +++ b/source/command/atlas-dataFederation-queryLimits-list.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits list ===================================== -.. meta:: - :description: List all data federation query limits for your project using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dataFederation queryLimits list Returns all data federation query limits for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-dataFederation-queryLimits.txt b/source/command/atlas-dataFederation-queryLimits.txt index ff23d7cb..16bec56f 100644 --- a/source/command/atlas-dataFederation-queryLimits.txt +++ b/source/command/atlas-dataFederation-queryLimits.txt @@ -4,9 +4,6 @@ atlas dataFederation queryLimits ================================ -.. meta:: - :description: Explore and manage data federation query limits with commands to create, delete, describe, and list limits in your project. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas dataFederation queryLimits Data federation query limits. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-dataFederation-update.txt b/source/command/atlas-dataFederation-update.txt index 9efe96d4..3600b5c8 100644 --- a/source/command/atlas-dataFederation-update.txt +++ b/source/command/atlas-dataFederation-update.txt @@ -14,6 +14,11 @@ atlas dataFederation update Modify the details of the specified data federation database for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dataFederation.txt b/source/command/atlas-dataFederation.txt index 2d04c689..585465dd 100644 --- a/source/command/atlas-dataFederation.txt +++ b/source/command/atlas-dataFederation.txt @@ -4,9 +4,6 @@ atlas dataFederation ==================== -.. meta:: - :description: Explore commands for managing Data Federation databases in Atlas, including creation, deletion, and querying. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas dataFederation Data federation. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-dbusers-certs-create.txt b/source/command/atlas-dbusers-certs-create.txt index e103f969..283c7a41 100644 --- a/source/command/atlas-dbusers-certs-create.txt +++ b/source/command/atlas-dbusers-certs-create.txt @@ -4,9 +4,6 @@ atlas dbusers certs create ========================== -.. meta:: - :description: Create an Atlas-managed X.509 certificate for a database user, specifying expiration and output options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers certs create Create a new Atlas-managed X.509 certificate for the specified database user. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The user you specify must authenticate using X.509 certificates. You can't use this command to create certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. Syntax diff --git a/source/command/atlas-dbusers-certs-list.txt b/source/command/atlas-dbusers-certs-list.txt index c57917be..d3d5556f 100644 --- a/source/command/atlas-dbusers-certs-list.txt +++ b/source/command/atlas-dbusers-certs-list.txt @@ -4,9 +4,6 @@ atlas dbusers certs list ======================== -.. meta:: - :description: List all unexpired Atlas-managed X.509 certificates for a specified database user using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers certs list Return all Atlas-managed, unexpired X.509 certificates for the specified database user. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can't use this command to return certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. The user you specify must authenticate using X.509 certificates. @@ -62,10 +64,22 @@ Options - - false - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. * - -o, --output - string - false - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. * - --projectId - string - false diff --git a/source/command/atlas-dbusers-certs.txt b/source/command/atlas-dbusers-certs.txt index e5cf674a..fa3cea6d 100644 --- a/source/command/atlas-dbusers-certs.txt +++ b/source/command/atlas-dbusers-certs.txt @@ -14,6 +14,13 @@ atlas dbusers certs Manage Atlas x509 certificates for your database users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-dbusers-create.txt b/source/command/atlas-dbusers-create.txt index 7dae5c31..36cc6c86 100644 --- a/source/command/atlas-dbusers-create.txt +++ b/source/command/atlas-dbusers-create.txt @@ -4,9 +4,6 @@ atlas dbusers create ==================== -.. meta:: - :description: Create a database user in Atlas with various authentication methods and roles using the CLI command `atlas dbusers create`. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers create Create a database user for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + If you set --ldapType, --x509Type, --oidcType and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-dbusers-delete.txt b/source/command/atlas-dbusers-delete.txt index 24611616..07b6d479 100644 --- a/source/command/atlas-dbusers-delete.txt +++ b/source/command/atlas-dbusers-delete.txt @@ -4,9 +4,6 @@ atlas dbusers delete ==================== -.. meta:: - :description: Remove a specified database user from your project using the Atlas CLI with options for authentication and project identification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers delete Remove the specified database user from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dbusers-describe.txt b/source/command/atlas-dbusers-describe.txt index f9d4d0fd..0eda7d33 100644 --- a/source/command/atlas-dbusers-describe.txt +++ b/source/command/atlas-dbusers-describe.txt @@ -4,9 +4,6 @@ atlas dbusers describe ====================== -.. meta:: - :description: Retrieve details of a specified database user in your project using the Atlas CLI command `atlas dbusers describe`. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers describe Return the details for the specified database user for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-dbusers-list.txt b/source/command/atlas-dbusers-list.txt index 1ad39381..71f58325 100644 --- a/source/command/atlas-dbusers-list.txt +++ b/source/command/atlas-dbusers-list.txt @@ -4,9 +4,6 @@ atlas dbusers list ================== -.. meta:: - :description: List all database users for your project using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers list Return all database users for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-dbusers-update.txt b/source/command/atlas-dbusers-update.txt index 897d764b..bd178e4a 100644 --- a/source/command/atlas-dbusers-update.txt +++ b/source/command/atlas-dbusers-update.txt @@ -4,9 +4,6 @@ atlas dbusers update ==================== -.. meta:: - :description: Update database user details in your project using the Atlas CLI, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers update Modify the details of a database user in your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-dbusers.txt b/source/command/atlas-dbusers.txt index b5be3a30..1b8e01d1 100644 --- a/source/command/atlas-dbusers.txt +++ b/source/command/atlas-dbusers.txt @@ -4,9 +4,6 @@ atlas dbusers ============= -.. meta:: - :description: Manage database users in your project with the dbusers command, including retrieval, creation, and modification of user roles across clusters. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas dbusers Manage database users for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The dbusers command retrieves, creates and modifies the MongoDB database users in your project. Each user has a set of roles that provide access to the project’s databases. A user’s roles apply to all the clusters in the project. diff --git a/source/command/atlas-deployments-connect.txt b/source/command/atlas-deployments-connect.txt index a8fa47dc..5b1d66b1 100644 --- a/source/command/atlas-deployments-connect.txt +++ b/source/command/atlas-deployments-connect.txt @@ -4,9 +4,6 @@ atlas deployments connect ========================= -.. meta:: - :description: Connect to a local or Atlas deployment using various methods and options, including specifying connection type and authentication credentials. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments connect Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ @@ -57,7 +61,7 @@ Options * - --connectWith - string - false - - Method for connecting to the deployment. Valid values are compass, connectionString and mongosh. + - Method for connecting to the deployment. Valid values are compass, connectionString, mongosh, and vscode. * - --connectionStringType - string - false diff --git a/source/command/atlas-deployments-delete.txt b/source/command/atlas-deployments-delete.txt index c5045c6a..e6f063c2 100644 --- a/source/command/atlas-deployments-delete.txt +++ b/source/command/atlas-deployments-delete.txt @@ -14,10 +14,16 @@ atlas deployments delete Delete a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Deleting an Atlas deployment also deletes any backup snapshots for that cluster. Deleting a Local deployment also deletes any local data volumes. +Deleting a deployment will not remove saved connections from MongoDB for VS Code. This must be done manually. To learn more, see https://www.mongodb.com/docs/mongodb-vscode/connect/#remove-a-connection. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-deployments-list.txt b/source/command/atlas-deployments-list.txt index aeeb077e..c1f02a3a 100644 --- a/source/command/atlas-deployments-list.txt +++ b/source/command/atlas-deployments-list.txt @@ -4,9 +4,6 @@ atlas deployments list ====================== -.. meta:: - :description: List all Atlas deployments using the CLI, with options for project ID and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments list Return all deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-logs.txt b/source/command/atlas-deployments-logs.txt index 70955b5c..db339904 100644 --- a/source/command/atlas-deployments-logs.txt +++ b/source/command/atlas-deployments-logs.txt @@ -4,9 +4,6 @@ atlas deployments logs ====================== -.. meta:: - :description: Retrieve deployment logs using various options like deployment name, host, and log file name. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments logs Get deployment logs. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-pause.txt b/source/command/atlas-deployments-pause.txt index aa73bdb3..5d5f05ca 100644 --- a/source/command/atlas-deployments-pause.txt +++ b/source/command/atlas-deployments-pause.txt @@ -4,9 +4,6 @@ atlas deployments pause ======================= -.. meta:: - :description: Pause a deployment using the Atlas CLI with options for specifying project ID, deployment type, and configuration profile. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments pause Pause a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-search-indexes-create.txt b/source/command/atlas-deployments-search-indexes-create.txt index 06d2cc09..692d8f40 100644 --- a/source/command/atlas-deployments-search-indexes-create.txt +++ b/source/command/atlas-deployments-search-indexes-create.txt @@ -4,9 +4,6 @@ atlas deployments search indexes create ======================================= -.. meta:: - :description: Create a search index for a specified deployment using various options like collection, database, and configuration file. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments search indexes create Create a search index for the specified deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-search-indexes-delete.txt b/source/command/atlas-deployments-search-indexes-delete.txt index c444211e..51de8a1b 100644 --- a/source/command/atlas-deployments-search-indexes-delete.txt +++ b/source/command/atlas-deployments-search-indexes-delete.txt @@ -4,9 +4,6 @@ atlas deployments search indexes delete ======================================= -.. meta:: - :description: Delete a specified search index from a deployment using the Atlas CLI command with various options for customization. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments search indexes delete Delete the specified search index from the specified deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-search-indexes-describe.txt b/source/command/atlas-deployments-search-indexes-describe.txt index a7e48835..adf5bc3f 100644 --- a/source/command/atlas-deployments-search-indexes-describe.txt +++ b/source/command/atlas-deployments-search-indexes-describe.txt @@ -4,9 +4,6 @@ atlas deployments search indexes describe ========================================= -.. meta:: - :description: Describe a search index for a specified deployment using the Atlas CLI command with various options for output and authentication. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments search indexes describe Describe a search index for the specified deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-search-indexes-list.txt b/source/command/atlas-deployments-search-indexes-list.txt index 926653e7..0123dd23 100644 --- a/source/command/atlas-deployments-search-indexes-list.txt +++ b/source/command/atlas-deployments-search-indexes-list.txt @@ -4,9 +4,6 @@ atlas deployments search indexes list ===================================== -.. meta:: - :description: List all Atlas Search indexes for a deployment using the Atlas CLI with various options for filtering and output formatting. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments search indexes list List all Atlas Search indexes for a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-deployments-search-indexes.txt b/source/command/atlas-deployments-search-indexes.txt index e585c945..31457d7c 100644 --- a/source/command/atlas-deployments-search-indexes.txt +++ b/source/command/atlas-deployments-search-indexes.txt @@ -14,6 +14,13 @@ atlas deployments search indexes Manage cloud and local search indexes. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-deployments-search.txt b/source/command/atlas-deployments-search.txt index dc0b73c8..bcfca8d0 100644 --- a/source/command/atlas-deployments-search.txt +++ b/source/command/atlas-deployments-search.txt @@ -14,6 +14,13 @@ atlas deployments search Manage search for cloud and local deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-deployments-setup.txt b/source/command/atlas-deployments-setup.txt index 56128cbf..3aeb5a45 100644 --- a/source/command/atlas-deployments-setup.txt +++ b/source/command/atlas-deployments-setup.txt @@ -4,9 +4,6 @@ atlas deployments setup ======================= -.. meta:: - :description: Set up a local deployment using the Atlas CLI with customizable options for IP access, connection method, and deployment type. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas deployments setup Create a local deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about local atlas deployments, see https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local/ Syntax @@ -69,7 +71,7 @@ Options * - --connectWith - string - false - - Method for connecting to the deployment. Valid values are compass, mongosh and skip. + - Method for connecting to the deployment. Valid values are compass, mongosh, vscode, and skip. Mutually exclusive with --skipMongosh. * - --currentIp diff --git a/source/command/atlas-deployments-start.txt b/source/command/atlas-deployments-start.txt index 4837b137..377cade0 100644 --- a/source/command/atlas-deployments-start.txt +++ b/source/command/atlas-deployments-start.txt @@ -4,9 +4,6 @@ atlas deployments start ======================= -.. meta:: - :description: Start a deployment using the Atlas CLI with options for specifying project ID, deployment type, and configuration profile. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas deployments start Start a deployment. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + After you stop a machine, it goes into sleep mode, or restarts. Syntax diff --git a/source/command/atlas-deployments.txt b/source/command/atlas-deployments.txt index c6487604..e6975458 100644 --- a/source/command/atlas-deployments.txt +++ b/source/command/atlas-deployments.txt @@ -4,9 +4,6 @@ atlas deployments ================= -.. meta:: - :description: Manage cloud and local deployments using Atlas CLI commands for connecting, deleting, listing, pausing, and starting deployments. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas deployments Manage cloud and local deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-events-organizations-list.txt b/source/command/atlas-events-organizations-list.txt index 0e01521a..7a409fdc 100644 --- a/source/command/atlas-events-organizations-list.txt +++ b/source/command/atlas-events-organizations-list.txt @@ -4,9 +4,6 @@ atlas events organizations list =============================== -.. meta:: - :description: List events for a specified organization using various options like date range, output format, and event type. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas events organizations list Return all events for the specified organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-events-organizations.txt b/source/command/atlas-events-organizations.txt index aca25de9..b9d16010 100644 --- a/source/command/atlas-events-organizations.txt +++ b/source/command/atlas-events-organizations.txt @@ -14,6 +14,11 @@ atlas events organizations Organization operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + List organization events. Options diff --git a/source/command/atlas-events-projects-list.txt b/source/command/atlas-events-projects-list.txt index 800d870c..e117c106 100644 --- a/source/command/atlas-events-projects-list.txt +++ b/source/command/atlas-events-projects-list.txt @@ -4,9 +4,6 @@ atlas events projects list ========================== -.. meta:: - :description: List all events for a specified project using various options like date range, output format, and event type. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas events projects list Return all events for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-events-projects.txt b/source/command/atlas-events-projects.txt index 1eeef0b8..8ac9f391 100644 --- a/source/command/atlas-events-projects.txt +++ b/source/command/atlas-events-projects.txt @@ -14,6 +14,11 @@ atlas events projects Project operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + List projects events. Options diff --git a/source/command/atlas-events.txt b/source/command/atlas-events.txt index 4191be55..09d6aea4 100644 --- a/source/command/atlas-events.txt +++ b/source/command/atlas-events.txt @@ -4,9 +4,6 @@ atlas events ============ -.. meta:: - :description: Manage events for your organization or project using the Atlas CLI with options for help and profile configuration. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas events Manage events for your organization or project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt index 0976024e..4cb091bc 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs connect ============================================================================ -.. meta:: - :description: Connect an Identity Provider to an Organization using the Atlas CLI with options for federation settings, identity provider ID, and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs connect Connect an Identity Provider to an Organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt index 5822056c..8e022877 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs delete =========================================================================== -.. meta:: - :description: Delete a connected organization configuration using the Atlas CLI with options for federation settings ID and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs delete Delete a connected org config Organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt index b15e0691..8b483022 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs describe ============================================================================= -.. meta:: - :description: Describe a connected organization configuration using the Atlas CLI with options for federation settings and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs describe Describe a Connected Org Config. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt index 581075ab..da51de9f 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect =============================================================================== -.. meta:: - :description: Disconnect an Identity Provider from an Organization using the Atlas CLI with specific options for federation settings and identity provider IDs. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect Connect an Identity Provider to an Organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt index f766b5f4..289b13e6 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs list ========================================================================= -.. meta:: - :description: List connected organization configurations using the Atlas CLI with options for pagination, output format, and organization ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs list Describe a Connected Org Config. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt index ca82fe96..47025eda 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs update =========================================================================== -.. meta:: - :description: Update a connected organization's configuration in Atlas using federation settings and a JSON file. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs update Update One Org Config Connected to One Federation Setting. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt index 5f21f585..e8881006 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs Manage Atlas Federated Authentication Connected Orgs Config +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-federatedAuthentication-federationSettings-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-describe.txt index 5dc4c944..ddf67b05 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-describe.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings describe ========================================================= -.. meta:: - :description: Retrieve Federation Settings details for an organization using the Atlas CLI command with options for output format and organization ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas federatedAuthentication federationSettings describe Return the Federation Settings details for the specified organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt index 633761f3..880de1ea 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider create oidc Create an OIDC identity provider. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt index 58d31e63..dd5cd1cb 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider create Create Federated Authentication Identity Providers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt index c0aaad11..1c237b31 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider delete Remove the specified identity provider from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt index 1977c6cd..fc6d536c 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider describe Describe the specified identity provider from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt index e0a92bbc..e359263f 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider list List the identity providers from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt index 99f29fd5..7ae06838 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider revokeJwk Revoke the JWK token from the specified identity provider from your federation settings. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt index 1b1ae150..1d8e798f 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider update oidc Update an OIDC identity provider. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt index 9ced3f51..6c617f01 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider update Update Federated Authentication Identity Providers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt index 6d6167ca..489fbcf6 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication federationSettings identityProvider ================================================================= -.. meta:: - :description: Manage Federated Authentication Identity Providers with options to create, delete, describe, list, revoke JWK, and update providers. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider Manage Federated Authentication Identity Providers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-federatedAuthentication-federationSettings.txt b/source/command/atlas-federatedAuthentication-federationSettings.txt index 65ff2f38..c90d0284 100644 --- a/source/command/atlas-federatedAuthentication-federationSettings.txt +++ b/source/command/atlas-federatedAuthentication-federationSettings.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings Manage Atlas Federated Authentication Federation Settings +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-federatedAuthentication.txt b/source/command/atlas-federatedAuthentication.txt index 21c67567..a07a2984 100644 --- a/source/command/atlas-federatedAuthentication.txt +++ b/source/command/atlas-federatedAuthentication.txt @@ -4,9 +4,6 @@ atlas federatedAuthentication ============================= -.. meta:: - :description: Manage federated authentication settings in Atlas using the CLI, with options for help and profile configuration. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas federatedAuthentication Manage Atlas Federated Authentication. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-integrations-create-DATADOG.txt b/source/command/atlas-integrations-create-DATADOG.txt index 4ff69b54..623e7478 100644 --- a/source/command/atlas-integrations-create-DATADOG.txt +++ b/source/command/atlas-integrations-create-DATADOG.txt @@ -14,6 +14,11 @@ atlas integrations create DATADOG Create or update a Datadog integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Datadog. After you integrate with Datadog, you can send metric data about your project to your Datadog dashboard. To learn more about the metrics available to Datadog, see https://www.mongodb.com/docs/atlas/tutorial/datadog-integration/. diff --git a/source/command/atlas-integrations-create-OPS_GENIE.txt b/source/command/atlas-integrations-create-OPS_GENIE.txt index f379cf6c..6a510190 100644 --- a/source/command/atlas-integrations-create-OPS_GENIE.txt +++ b/source/command/atlas-integrations-create-OPS_GENIE.txt @@ -14,6 +14,11 @@ atlas integrations create OPS_GENIE Create or update an Opsgenie integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Opsgenie. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-integrations-create-PAGER_DUTY.txt b/source/command/atlas-integrations-create-PAGER_DUTY.txt index 4772a69a..2cefcd56 100644 --- a/source/command/atlas-integrations-create-PAGER_DUTY.txt +++ b/source/command/atlas-integrations-create-PAGER_DUTY.txt @@ -14,6 +14,11 @@ atlas integrations create PAGER_DUTY Create or update a PagerDuty integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with PagerDuty. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-integrations-create-VICTOR_OPS.txt b/source/command/atlas-integrations-create-VICTOR_OPS.txt index 8c7bf304..e626922f 100644 --- a/source/command/atlas-integrations-create-VICTOR_OPS.txt +++ b/source/command/atlas-integrations-create-VICTOR_OPS.txt @@ -14,6 +14,11 @@ atlas integrations create VICTOR_OPS Create or update a Splunk On-Call integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + VictorOps is now Splunk On-Call. The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Splunk On-Call. diff --git a/source/command/atlas-integrations-create-WEBHOOK.txt b/source/command/atlas-integrations-create-WEBHOOK.txt index 32dccd71..9abb2a43 100644 --- a/source/command/atlas-integrations-create-WEBHOOK.txt +++ b/source/command/atlas-integrations-create-WEBHOOK.txt @@ -14,6 +14,11 @@ atlas integrations create WEBHOOK Create or update a webhook integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The requesting API key must have the Organization Owner or Project Owner role to configure a webhook integration. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-integrations-create.txt b/source/command/atlas-integrations-create.txt index 85048bcd..5daecc73 100644 --- a/source/command/atlas-integrations-create.txt +++ b/source/command/atlas-integrations-create.txt @@ -14,6 +14,13 @@ atlas integrations create Create operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-integrations-delete.txt b/source/command/atlas-integrations-delete.txt index 63239e64..c81f0184 100644 --- a/source/command/atlas-integrations-delete.txt +++ b/source/command/atlas-integrations-delete.txt @@ -14,6 +14,11 @@ atlas integrations delete Remove the specified third-party integration from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Deleting an integration from a project removes that integration configuration only for that project. This does not affect any other project or organization's configured integrations. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-integrations-describe.txt b/source/command/atlas-integrations-describe.txt index 8d004688..9236f280 100644 --- a/source/command/atlas-integrations-describe.txt +++ b/source/command/atlas-integrations-describe.txt @@ -14,6 +14,11 @@ atlas integrations describe Return the details for the specified third-party integration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-integrations-list.txt b/source/command/atlas-integrations-list.txt index 46aefedf..879563f7 100644 --- a/source/command/atlas-integrations-list.txt +++ b/source/command/atlas-integrations-list.txt @@ -14,6 +14,11 @@ atlas integrations list Return all active third-party integrations for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-integrations.txt b/source/command/atlas-integrations.txt index 6850731c..92ca1d1a 100644 --- a/source/command/atlas-integrations.txt +++ b/source/command/atlas-integrations.txt @@ -4,9 +4,6 @@ atlas integrations ================== -.. meta:: - :description: Configure third-party integrations for your Atlas project using various command options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas integrations Configure third-party integrations for your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-liveMigrations-create.txt b/source/command/atlas-liveMigrations-create.txt index 29f48c9a..9f410ab0 100644 --- a/source/command/atlas-liveMigrations-create.txt +++ b/source/command/atlas-liveMigrations-create.txt @@ -4,9 +4,6 @@ atlas liveMigrations create =========================== -.. meta:: - :description: Create a new live migration in Atlas using the CLI with options for source and destination cluster configurations. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas liveMigrations create Create a new push live migration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/source/command/atlas-liveMigrations-cutover.txt b/source/command/atlas-liveMigrations-cutover.txt index 005844a9..28762981 100644 --- a/source/command/atlas-liveMigrations-cutover.txt +++ b/source/command/atlas-liveMigrations-cutover.txt @@ -4,9 +4,6 @@ atlas liveMigrations cutover ============================ -.. meta:: - :description: Initiate and confirm the completion of a cutover for a live migration using the Atlas CLI, stopping synchronization with the source cluster. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas liveMigrations cutover Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/source/command/atlas-liveMigrations-describe.txt b/source/command/atlas-liveMigrations-describe.txt index d169557a..fc5c6972 100644 --- a/source/command/atlas-liveMigrations-describe.txt +++ b/source/command/atlas-liveMigrations-describe.txt @@ -4,9 +4,6 @@ atlas liveMigrations describe ============================= -.. meta:: - :description: Describe a live migration job in Atlas using the `atlas liveMigrations describe` command with required options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas liveMigrations describe Return a push live migration job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-liveMigrations-link-create.txt b/source/command/atlas-liveMigrations-link-create.txt index e3abf012..dfdfb601 100644 --- a/source/command/atlas-liveMigrations-link-create.txt +++ b/source/command/atlas-liveMigrations-link-create.txt @@ -4,9 +4,6 @@ atlas liveMigrations link create ================================ -.. meta:: - :description: Create a link-token for push live migration using the Atlas CLI with customizable options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas liveMigrations link create Create a new link-token for a push live migration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/source/command/atlas-liveMigrations-link-delete.txt b/source/command/atlas-liveMigrations-link-delete.txt index efc103dc..e50a4af0 100644 --- a/source/command/atlas-liveMigrations-link-delete.txt +++ b/source/command/atlas-liveMigrations-link-delete.txt @@ -4,9 +4,6 @@ atlas liveMigrations link delete ================================ -.. meta:: - :description: Delete a link-token using the Atlas CLI with options to skip confirmation and specify organization ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas liveMigrations link delete Delete one link-token. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-liveMigrations-link.txt b/source/command/atlas-liveMigrations-link.txt index 7d81d1f0..04ae43d8 100644 --- a/source/command/atlas-liveMigrations-link.txt +++ b/source/command/atlas-liveMigrations-link.txt @@ -14,6 +14,13 @@ atlas liveMigrations link Manage the link-token for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-liveMigrations-validation-create.txt b/source/command/atlas-liveMigrations-validation-create.txt index 0518468c..a427a530 100644 --- a/source/command/atlas-liveMigrations-validation-create.txt +++ b/source/command/atlas-liveMigrations-validation-create.txt @@ -4,9 +4,6 @@ atlas liveMigrations validation create ====================================== -.. meta:: - :description: Create a validation request for a push live migration using the Atlas CLI, specifying options like cluster names, migration hosts, and authentication details. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas liveMigrations validation create Create a new validation request for a push live migration. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/source/command/atlas-liveMigrations-validation-describe.txt b/source/command/atlas-liveMigrations-validation-describe.txt index bad62f31..ab5baf95 100644 --- a/source/command/atlas-liveMigrations-validation-describe.txt +++ b/source/command/atlas-liveMigrations-validation-describe.txt @@ -4,9 +4,6 @@ atlas liveMigrations validation describe ======================================== -.. meta:: - :description: Describe a validation job for live migrations in Atlas using the CLI command with various output options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas liveMigrations validation describe Return one validation job. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-liveMigrations-validation.txt b/source/command/atlas-liveMigrations-validation.txt index e0e17476..da2ef7d2 100644 --- a/source/command/atlas-liveMigrations-validation.txt +++ b/source/command/atlas-liveMigrations-validation.txt @@ -14,6 +14,13 @@ atlas liveMigrations validation Manage a Live Migration validation job for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-liveMigrations.txt b/source/command/atlas-liveMigrations.txt index a7e820c1..90effdf8 100644 --- a/source/command/atlas-liveMigrations.txt +++ b/source/command/atlas-liveMigrations.txt @@ -4,9 +4,6 @@ atlas liveMigrations ==================== -.. meta:: - :description: Manage live migrations to Atlas, including creating, starting cutover, describing jobs, and handling link-tokens and validation. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas liveMigrations Manage a Live Migration to Atlas for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-logs-download.txt b/source/command/atlas-logs-download.txt index e2641a65..30e7b5c9 100644 --- a/source/command/atlas-logs-download.txt +++ b/source/command/atlas-logs-download.txt @@ -4,9 +4,6 @@ atlas logs download =================== -.. meta:: - :description: Download MongoDB logs from a specified host using the Atlas CLI, with options for decompression, date range, and output file settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas logs download Download a compressed file that contains the MongoDB logs for the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command downloads a file with a .gz extension. To find the hostnames for an Atlas project, use the process list command. diff --git a/source/command/atlas-logs.txt b/source/command/atlas-logs.txt index dd69f781..ca910c3c 100644 --- a/source/command/atlas-logs.txt +++ b/source/command/atlas-logs.txt @@ -4,9 +4,6 @@ atlas logs ========== -.. meta:: - :description: Download host logs for your project using the Atlas CLI with options for help and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas logs Download host logs for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-maintenanceWindows-clear.txt b/source/command/atlas-maintenanceWindows-clear.txt index 300aafbd..d268de71 100644 --- a/source/command/atlas-maintenanceWindows-clear.txt +++ b/source/command/atlas-maintenanceWindows-clear.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows clear Clear the current maintenance window setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-maintenanceWindows-defer.txt b/source/command/atlas-maintenanceWindows-defer.txt index f586ce1e..142f73f6 100644 --- a/source/command/atlas-maintenanceWindows-defer.txt +++ b/source/command/atlas-maintenanceWindows-defer.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows defer Defer scheduled maintenance for your project for one week. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-maintenanceWindows-describe.txt b/source/command/atlas-maintenanceWindows-describe.txt index 2401651d..7ab67f4a 100644 --- a/source/command/atlas-maintenanceWindows-describe.txt +++ b/source/command/atlas-maintenanceWindows-describe.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows describe Return the maintenance window details for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/source/command/atlas-maintenanceWindows-update.txt b/source/command/atlas-maintenanceWindows-update.txt index affa97dd..afe0e2be 100644 --- a/source/command/atlas-maintenanceWindows-update.txt +++ b/source/command/atlas-maintenanceWindows-update.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows update Modify the maintenance window for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-maintenanceWindows.txt b/source/command/atlas-maintenanceWindows.txt index 3b0c46c4..d873ba6e 100644 --- a/source/command/atlas-maintenanceWindows.txt +++ b/source/command/atlas-maintenanceWindows.txt @@ -4,9 +4,6 @@ atlas maintenanceWindows ======================== -.. meta:: - :description: Manage maintenance windows in Atlas, including options to clear, defer, describe, and update settings for your project. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas maintenanceWindows Manage Atlas maintenance windows. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-metrics-databases-describe.txt b/source/command/atlas-metrics-databases-describe.txt index 74def3d3..6d9ca9e0 100644 --- a/source/command/atlas-metrics-databases-describe.txt +++ b/source/command/atlas-metrics-databases-describe.txt @@ -14,6 +14,11 @@ atlas metrics databases describe Return the measurements of a database on the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas process list diff --git a/source/command/atlas-metrics-databases-list.txt b/source/command/atlas-metrics-databases-list.txt index b3cc8994..1be0cf37 100644 --- a/source/command/atlas-metrics-databases-list.txt +++ b/source/command/atlas-metrics-databases-list.txt @@ -14,6 +14,11 @@ atlas metrics databases list Return all databases running on the specified host for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/source/command/atlas-metrics-databases.txt b/source/command/atlas-metrics-databases.txt index 2db0e1a8..83f8f80b 100644 --- a/source/command/atlas-metrics-databases.txt +++ b/source/command/atlas-metrics-databases.txt @@ -14,6 +14,13 @@ atlas metrics databases List available databases or database metrics for a given host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-metrics-disks-describe.txt b/source/command/atlas-metrics-disks-describe.txt index 3e203441..2948833c 100644 --- a/source/command/atlas-metrics-disks-describe.txt +++ b/source/command/atlas-metrics-disks-describe.txt @@ -14,6 +14,11 @@ atlas metrics disks describe Return the measurements of a disk or partition on the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/source/command/atlas-metrics-disks-list.txt b/source/command/atlas-metrics-disks-list.txt index d541f41a..86436a8b 100644 --- a/source/command/atlas-metrics-disks-list.txt +++ b/source/command/atlas-metrics-disks-list.txt @@ -14,6 +14,11 @@ atlas metrics disks list Return all disks or disk partitions on the specified host for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run: $ atlas processes list diff --git a/source/command/atlas-metrics-disks.txt b/source/command/atlas-metrics-disks.txt index 42bd8f21..2c0651ea 100644 --- a/source/command/atlas-metrics-disks.txt +++ b/source/command/atlas-metrics-disks.txt @@ -14,6 +14,13 @@ atlas metrics disks List available disks or disk metrics for a given host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-metrics-processes.txt b/source/command/atlas-metrics-processes.txt index bd7d9690..6852b579 100644 --- a/source/command/atlas-metrics-processes.txt +++ b/source/command/atlas-metrics-processes.txt @@ -4,9 +4,6 @@ atlas metrics processes ======================= -.. meta:: - :description: Retrieve process measurements for a specified host using the Atlas CLI, with options for output format, time period, and more. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas metrics processes Return the process measurements for the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/source/command/atlas-metrics.txt b/source/command/atlas-metrics.txt index b4a6bc06..dad08d1c 100644 --- a/source/command/atlas-metrics.txt +++ b/source/command/atlas-metrics.txt @@ -4,9 +4,6 @@ atlas metrics ============= -.. meta:: - :description: Retrieve metrics on MongoDB processes using the Atlas CLI with options for profiles and help. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas metrics Get metrics on the MongoDB process. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-networking-containers-delete.txt b/source/command/atlas-networking-containers-delete.txt index 38a4df5f..0eff902b 100644 --- a/source/command/atlas-networking-containers-delete.txt +++ b/source/command/atlas-networking-containers-delete.txt @@ -4,9 +4,6 @@ atlas networking containers delete ================================== -.. meta:: - :description: Delete a specified network peering container from your Atlas project using the CLI, ensuring no clusters exist in the project. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking containers delete Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-networking-containers-list.txt b/source/command/atlas-networking-containers-list.txt index 7525ae94..26ea59bb 100644 --- a/source/command/atlas-networking-containers-list.txt +++ b/source/command/atlas-networking-containers-list.txt @@ -4,9 +4,6 @@ atlas networking containers list ================================ -.. meta:: - :description: List all network peering containers for your project using the Atlas CLI, with options for output format, pagination, and provider specification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking containers list Return all network peering containers for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-networking-containers.txt b/source/command/atlas-networking-containers.txt index 67563691..de3d5bd3 100644 --- a/source/command/atlas-networking-containers.txt +++ b/source/command/atlas-networking-containers.txt @@ -14,6 +14,13 @@ atlas networking containers Manage Network Peering containers. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-networking-peering-create-aws.txt b/source/command/atlas-networking-peering-create-aws.txt index dac2fb7f..9190d9e7 100644 --- a/source/command/atlas-networking-peering-create-aws.txt +++ b/source/command/atlas-networking-peering-create-aws.txt @@ -4,9 +4,6 @@ atlas networking peering create aws =================================== -.. meta:: - :description: Create a network peering connection between your AWS VPC and the Atlas VPC using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking peering create aws Create a network peering connection between the Atlas VPC and your AWS VPC. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. diff --git a/source/command/atlas-networking-peering-create-azure.txt b/source/command/atlas-networking-peering-create-azure.txt index 00ef096a..6376ab7a 100644 --- a/source/command/atlas-networking-peering-create-azure.txt +++ b/source/command/atlas-networking-peering-create-azure.txt @@ -4,9 +4,6 @@ atlas networking peering create azure ===================================== -.. meta:: - :description: Create a network peering connection between an Atlas VPC and an Azure VNet using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking peering create azure Create a network peering connection between the Atlas VPC and your Azure VNet. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Before you create an Azure network peering connection, complete the prerequisites listed here: https://www.mongodb.com/docs/atlas/reference/api/vpc-create-peering-connection/#prerequisites. The network peering create command checks if a VNet exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VNet and your VPC. If an Atlas VPC does not exist, this command creates one and creates a connection between it and your VNet. diff --git a/source/command/atlas-networking-peering-create-gcp.txt b/source/command/atlas-networking-peering-create-gcp.txt index 68ee6738..e8428e69 100644 --- a/source/command/atlas-networking-peering-create-gcp.txt +++ b/source/command/atlas-networking-peering-create-gcp.txt @@ -4,9 +4,6 @@ atlas networking peering create gcp =================================== -.. meta:: - :description: Create a network peering connection between your Atlas VPC and Google Cloud VPC using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking peering create gcp Create a network peering connection between the Atlas VPC and your Google Cloud VPC. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. diff --git a/source/command/atlas-networking-peering-create.txt b/source/command/atlas-networking-peering-create.txt index fbe947b7..95c2a81e 100644 --- a/source/command/atlas-networking-peering-create.txt +++ b/source/command/atlas-networking-peering-create.txt @@ -14,6 +14,13 @@ atlas networking peering create Create a connection with AWS, Azure and Google Cloud. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-networking-peering-delete.txt b/source/command/atlas-networking-peering-delete.txt index a0c8cb58..44a6c65e 100644 --- a/source/command/atlas-networking-peering-delete.txt +++ b/source/command/atlas-networking-peering-delete.txt @@ -4,9 +4,6 @@ atlas networking peering delete =============================== -.. meta:: - :description: Remove a specified network peering connection from your project using the Atlas CLI with options for authentication and confirmation prompts. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking peering delete Remove the specified peering connection from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-networking-peering-list.txt b/source/command/atlas-networking-peering-list.txt index f1e956be..97fa456c 100644 --- a/source/command/atlas-networking-peering-list.txt +++ b/source/command/atlas-networking-peering-list.txt @@ -4,9 +4,6 @@ atlas networking peering list ============================= -.. meta:: - :description: List network peering connections for your project using the Atlas CLI, with options for output format and pagination. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking peering list Return the details for all network peering connections for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-networking-peering-watch.txt b/source/command/atlas-networking-peering-watch.txt index 7339bc2d..25b55ff4 100644 --- a/source/command/atlas-networking-peering-watch.txt +++ b/source/command/atlas-networking-peering-watch.txt @@ -4,9 +4,6 @@ atlas networking peering watch ============================== -.. meta:: - :description: Monitor a specified network peering connection in your project until it becomes available using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas networking peering watch Watch the specified peering connection in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the peering connection's status periodically until it becomes available. Once it reaches the expected state, the command prints "Network peering changes completed." If you run the command in the terminal, it blocks the terminal session until the resource is available. diff --git a/source/command/atlas-networking-peering.txt b/source/command/atlas-networking-peering.txt index fdeb3a8f..687e0a1c 100644 --- a/source/command/atlas-networking-peering.txt +++ b/source/command/atlas-networking-peering.txt @@ -14,6 +14,13 @@ atlas networking peering Manage Network Peering connections. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-networking.txt b/source/command/atlas-networking.txt index 6eb24bfb..6ee3e678 100644 --- a/source/command/atlas-networking.txt +++ b/source/command/atlas-networking.txt @@ -4,9 +4,6 @@ atlas networking ================ -.. meta:: - :description: Configure network peering for your Atlas project using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas networking Manage or configure network peering for your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-organizations-apiKeys-accessLists-create.txt b/source/command/atlas-organizations-apiKeys-accessLists-create.txt index c4d2bf34..a039b352 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists-create.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys accessLists create ============================================== -.. meta:: - :description: Create an IP access list entry for your API Key using the Atlas CLI with options for CIDR notation, current IP, and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas organizations apiKeys accessLists create Create an IP access list entry for your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the apiKey option, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Read Write role. diff --git a/source/command/atlas-organizations-apiKeys-accessLists-delete.txt b/source/command/atlas-organizations-apiKeys-accessLists-delete.txt index 40829b9b..5a81d551 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists-delete.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys accessLists delete ============================================== -.. meta:: - :description: Remove an IP access list entry from your API Key using the Atlas CLI command with authentication and optional parameters. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas organizations apiKeys accessLists delete Remove the specified IP access list entry from your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Read Write role. Syntax diff --git a/source/command/atlas-organizations-apiKeys-accessLists-list.txt b/source/command/atlas-organizations-apiKeys-accessLists-list.txt index a702ead2..d255724b 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists-list.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys accessLists list ============================================ -.. meta:: - :description: Retrieve all IP access list entries for your API Key using the Atlas CLI, with options for output format and pagination. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas organizations apiKeys accessLists list Return all IP access list entries for your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the apiKeyID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/source/command/atlas-organizations-apiKeys-accessLists.txt b/source/command/atlas-organizations-apiKeys-accessLists.txt index 93b1ff20..e7d543fd 100644 --- a/source/command/atlas-organizations-apiKeys-accessLists.txt +++ b/source/command/atlas-organizations-apiKeys-accessLists.txt @@ -14,6 +14,13 @@ atlas organizations apiKeys accessLists Manage the IP access list for your API Key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-organizations-apiKeys-assign.txt b/source/command/atlas-organizations-apiKeys-assign.txt index 9842e895..554977aa 100644 --- a/source/command/atlas-organizations-apiKeys-assign.txt +++ b/source/command/atlas-organizations-apiKeys-assign.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys assign Modify the roles or description for the specified organization API key. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. To view possible values for the apiKeyId argument, run atlas organizations apiKeys list. diff --git a/source/command/atlas-organizations-apiKeys-create.txt b/source/command/atlas-organizations-apiKeys-create.txt index c285d2e9..31883a71 100644 --- a/source/command/atlas-organizations-apiKeys-create.txt +++ b/source/command/atlas-organizations-apiKeys-create.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys create Create an API Key for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/source/command/atlas-organizations-apiKeys-delete.txt b/source/command/atlas-organizations-apiKeys-delete.txt index 37edd780..f3595e7f 100644 --- a/source/command/atlas-organizations-apiKeys-delete.txt +++ b/source/command/atlas-organizations-apiKeys-delete.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys delete Remove the specified API key for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the ID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/source/command/atlas-organizations-apiKeys-describe.txt b/source/command/atlas-organizations-apiKeys-describe.txt index 19b24d2c..ab7980d2 100644 --- a/source/command/atlas-organizations-apiKeys-describe.txt +++ b/source/command/atlas-organizations-apiKeys-describe.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys describe Return the details for the specified API key for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To view possible values for the ID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/source/command/atlas-organizations-apiKeys-list.txt b/source/command/atlas-organizations-apiKeys-list.txt index 7063d638..e8126666 100644 --- a/source/command/atlas-organizations-apiKeys-list.txt +++ b/source/command/atlas-organizations-apiKeys-list.txt @@ -4,9 +4,6 @@ atlas organizations apiKeys list ================================ -.. meta:: - :description: Retrieve all API keys for your organization using the Atlas CLI with options for output format, pagination, and organization ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas organizations apiKeys list Return all API keys for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-organizations-apiKeys.txt b/source/command/atlas-organizations-apiKeys.txt index d4af319a..be40b454 100644 --- a/source/command/atlas-organizations-apiKeys.txt +++ b/source/command/atlas-organizations-apiKeys.txt @@ -14,6 +14,13 @@ atlas organizations apiKeys Organization API Keys operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-organizations-create.txt b/source/command/atlas-organizations-create.txt index a4060a22..0d798f85 100644 --- a/source/command/atlas-organizations-create.txt +++ b/source/command/atlas-organizations-create.txt @@ -4,9 +4,6 @@ atlas organizations create ========================== -.. meta:: - :description: Create an organization in Atlas using the CLI, with options for API key roles, federation settings, and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas organizations create Create an organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org. Syntax diff --git a/source/command/atlas-organizations-delete.txt b/source/command/atlas-organizations-delete.txt index 1f6a6afc..3fe1adae 100644 --- a/source/command/atlas-organizations-delete.txt +++ b/source/command/atlas-organizations-delete.txt @@ -14,6 +14,11 @@ atlas organizations delete Remove the specified organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Organizations with active projects can't be removed. To use this command, you must authenticate with a user account or an API key with the Organization Owner role. diff --git a/source/command/atlas-organizations-describe.txt b/source/command/atlas-organizations-describe.txt index 52b0e108..722ee413 100644 --- a/source/command/atlas-organizations-describe.txt +++ b/source/command/atlas-organizations-describe.txt @@ -14,6 +14,11 @@ atlas organizations describe Return the details for the specified organizations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-organizations-invitations-delete.txt b/source/command/atlas-organizations-invitations-delete.txt index ebd795ec..934847c7 100644 --- a/source/command/atlas-organizations-invitations-delete.txt +++ b/source/command/atlas-organizations-invitations-delete.txt @@ -14,6 +14,11 @@ atlas organizations invitations delete Remove the specified pending invitation to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/source/command/atlas-organizations-invitations-describe.txt b/source/command/atlas-organizations-invitations-describe.txt index c842a75f..f261f57b 100644 --- a/source/command/atlas-organizations-invitations-describe.txt +++ b/source/command/atlas-organizations-invitations-describe.txt @@ -14,6 +14,11 @@ atlas organizations invitations describe Return the details for the specified pending invitation to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/source/command/atlas-organizations-invitations-invite.txt b/source/command/atlas-organizations-invitations-invite.txt index d62a0a92..34a17c3d 100644 --- a/source/command/atlas-organizations-invitations-invite.txt +++ b/source/command/atlas-organizations-invitations-invite.txt @@ -14,6 +14,11 @@ atlas organizations invitations invite Invite the specified MongoDB user to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/source/command/atlas-organizations-invitations-list.txt b/source/command/atlas-organizations-invitations-list.txt index 074015dd..4f48a092 100644 --- a/source/command/atlas-organizations-invitations-list.txt +++ b/source/command/atlas-organizations-invitations-list.txt @@ -14,6 +14,11 @@ atlas organizations invitations list Return all pending invitations to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/source/command/atlas-organizations-invitations-update.txt b/source/command/atlas-organizations-invitations-update.txt index 446dcf4f..74e04f02 100644 --- a/source/command/atlas-organizations-invitations-update.txt +++ b/source/command/atlas-organizations-invitations-update.txt @@ -14,6 +14,11 @@ atlas organizations invitations update Modifies the details of the specified pending invitation to your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can use either the invitation ID or the user's email address to specify the invitation. To use this command, you must authenticate with a user account or an API key with the Organization Owner role. diff --git a/source/command/atlas-organizations-invitations.txt b/source/command/atlas-organizations-invitations.txt index 0135c986..c0e1dfe0 100644 --- a/source/command/atlas-organizations-invitations.txt +++ b/source/command/atlas-organizations-invitations.txt @@ -14,6 +14,11 @@ atlas organizations invitations Invitation operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your MongoDB organization invites. Options diff --git a/source/command/atlas-organizations-list.txt b/source/command/atlas-organizations-list.txt index 52481476..76f481fe 100644 --- a/source/command/atlas-organizations-list.txt +++ b/source/command/atlas-organizations-list.txt @@ -14,6 +14,11 @@ atlas organizations list Return all organizations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-organizations-users-list.txt b/source/command/atlas-organizations-users-list.txt index 94299faa..2cc14d06 100644 --- a/source/command/atlas-organizations-users-list.txt +++ b/source/command/atlas-organizations-users-list.txt @@ -14,6 +14,11 @@ atlas organizations users list Return all users for an organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-organizations-users.txt b/source/command/atlas-organizations-users.txt index 928a8825..e0319afe 100644 --- a/source/command/atlas-organizations-users.txt +++ b/source/command/atlas-organizations-users.txt @@ -14,6 +14,13 @@ atlas organizations users Manage your Atlas users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-organizations.txt b/source/command/atlas-organizations.txt index 14eb45bf..b6c694c2 100644 --- a/source/command/atlas-organizations.txt +++ b/source/command/atlas-organizations.txt @@ -4,9 +4,6 @@ atlas organizations =================== -.. meta:: - :description: Manage Atlas organizations by creating, listing, and handling various operations using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas organizations Manage your Atlas organizations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your MongoDB organizations. Options diff --git a/source/command/atlas-performanceAdvisor-namespaces-list.txt b/source/command/atlas-performanceAdvisor-namespaces-list.txt index 19b5659d..ec9bb3ac 100644 --- a/source/command/atlas-performanceAdvisor-namespaces-list.txt +++ b/source/command/atlas-performanceAdvisor-namespaces-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor namespaces list Return up to 20 namespaces for collections experiencing slow queries on the specified host. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Namespaces appear in the following format: {database}.{collection}. If you don't set the duration option or the since option, this command returns data from the last 24 hours. diff --git a/source/command/atlas-performanceAdvisor-namespaces.txt b/source/command/atlas-performanceAdvisor-namespaces.txt index e05970fb..34190e7c 100644 --- a/source/command/atlas-performanceAdvisor-namespaces.txt +++ b/source/command/atlas-performanceAdvisor-namespaces.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor namespaces Retrieve namespaces for collections experiencing slow queries +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt b/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt index 09b64bb4..92f48a87 100644 --- a/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt +++ b/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowOperationThreshold disable Disable the application-managed slow operation threshold for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When disabled, the application considers any operation that takes longer than 100 milliseconds to be slow. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt b/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt index c47613c4..5b7d9adf 100644 --- a/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt +++ b/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowOperationThreshold enable Enable the application-managed slow operation threshold for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When enabled, the application uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. Application-managed slow operation threshold is enabled by default for dedicated clusters (M10+). To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt b/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt index a5ad1e3e..dfb91ea6 100644 --- a/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt +++ b/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor slowOperationThreshold Enable or disable management of the slow operation threshold for your cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt b/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt index 52ad8c40..a8bd30ec 100644 --- a/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt +++ b/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowQueryLogs list Return log lines for slow queries that the Performance Advisor and Query Profiler identified. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. The threshold for slow queries varies based on the average time of operations on your cluster to provide recommendations pertinent to your workload. If you don't set the duration option or the since option, this command returns data from the last 24 hours. diff --git a/source/command/atlas-performanceAdvisor-slowQueryLogs.txt b/source/command/atlas-performanceAdvisor-slowQueryLogs.txt index 02fbbab1..ba09f494 100644 --- a/source/command/atlas-performanceAdvisor-slowQueryLogs.txt +++ b/source/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -4,9 +4,6 @@ atlas performanceAdvisor slowQueryLogs ====================================== -.. meta:: - :description: Retrieve log lines for slow queries on a specified host using the Atlas Performance Advisor. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas performanceAdvisor slowQueryLogs Get log lines for slow queries for a specified host +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt index a0e2a276..e022efb7 100644 --- a/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt +++ b/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -4,9 +4,6 @@ atlas performanceAdvisor suggestedIndexes list ============================================== -.. meta:: - :description: Retrieve suggested indexes to optimize query performance for collections with slow queries using the Performance Advisor. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas performanceAdvisor suggestedIndexes list Return the suggested indexes for collections experiencing slow queries. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/source/command/atlas-performanceAdvisor-suggestedIndexes.txt b/source/command/atlas-performanceAdvisor-suggestedIndexes.txt index b765cf2e..76a3635b 100644 --- a/source/command/atlas-performanceAdvisor-suggestedIndexes.txt +++ b/source/command/atlas-performanceAdvisor-suggestedIndexes.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor suggestedIndexes Get suggested indexes for collections experiencing slow queries +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-performanceAdvisor.txt b/source/command/atlas-performanceAdvisor.txt index f52f2347..7549addd 100644 --- a/source/command/atlas-performanceAdvisor.txt +++ b/source/command/atlas-performanceAdvisor.txt @@ -4,9 +4,6 @@ atlas performanceAdvisor ======================== -.. meta:: - :description: Explore slow queries and receive suggestions to enhance database performance using the Atlas Performance Advisor command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas performanceAdvisor Learn more about slow queries and get suggestions to improve database performance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-plugin-install.txt b/source/command/atlas-plugin-install.txt index fa57e08f..507ada6b 100644 --- a/source/command/atlas-plugin-install.txt +++ b/source/command/atlas-plugin-install.txt @@ -14,6 +14,11 @@ atlas plugin install Install Atlas CLI plugin from a GitHub repository. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Install an Atlas CLI plugin from a GitHub repository. You can specify a GitHub repository using either the "/" format or a full URL. When you install the plugin, its latest release on GitHub is used by default. diff --git a/source/command/atlas-plugin-list.txt b/source/command/atlas-plugin-list.txt index eced103a..15389bf9 100644 --- a/source/command/atlas-plugin-list.txt +++ b/source/command/atlas-plugin-list.txt @@ -14,6 +14,13 @@ atlas plugin list Returns a list of all installed plugins. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-plugin-uninstall.txt b/source/command/atlas-plugin-uninstall.txt index 6117d6b5..4bd502c1 100644 --- a/source/command/atlas-plugin-uninstall.txt +++ b/source/command/atlas-plugin-uninstall.txt @@ -14,6 +14,11 @@ atlas plugin uninstall Uninstall Atlas CLI plugin. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Uninstall an Atlas CLI plugin. You can specify a plugin to uninstall using either the "/" format or the plugin name. diff --git a/source/command/atlas-plugin-update.txt b/source/command/atlas-plugin-update.txt index e91b6561..2c836add 100644 --- a/source/command/atlas-plugin-update.txt +++ b/source/command/atlas-plugin-update.txt @@ -14,6 +14,11 @@ atlas plugin update Update Atlas CLI plugin. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Update an Atlas CLI plugin. You can specify a plugin to update using either the "/" format or the plugin name. Additionally, you can use the "--all" flag to update all plugins. diff --git a/source/command/atlas-plugin.txt b/source/command/atlas-plugin.txt index c3c489f4..cde9a890 100644 --- a/source/command/atlas-plugin.txt +++ b/source/command/atlas-plugin.txt @@ -14,6 +14,13 @@ atlas plugin Manage plugins for the AtlasCLI. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-aws-create.txt b/source/command/atlas-privateEndpoints-aws-create.txt index 3dc0a823..dc8508e0 100644 --- a/source/command/atlas-privateEndpoints-aws-create.txt +++ b/source/command/atlas-privateEndpoints-aws-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws create Create a new AWS private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-privateEndpoints-aws-delete.txt b/source/command/atlas-privateEndpoints-aws-delete.txt index 99afb3ec..eb5e8b82 100644 --- a/source/command/atlas-privateEndpoints-aws-delete.txt +++ b/source/command/atlas-privateEndpoints-aws-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws delete Remove the specified AWS private endpoint from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-aws-describe.txt b/source/command/atlas-privateEndpoints-aws-describe.txt index aa7a2433..9817400d 100644 --- a/source/command/atlas-privateEndpoints-aws-describe.txt +++ b/source/command/atlas-privateEndpoints-aws-describe.txt @@ -4,9 +4,6 @@ atlas privateEndpoints aws describe =================================== -.. meta:: - :description: Retrieve details of AWS private endpoints in your project using the Atlas CLI command with specified options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas privateEndpoints aws describe Return the details for the specified AWS private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-aws-interfaces-create.txt b/source/command/atlas-privateEndpoints-aws-interfaces-create.txt index fcaeafe8..02ca7211 100644 --- a/source/command/atlas-privateEndpoints-aws-interfaces-create.txt +++ b/source/command/atlas-privateEndpoints-aws-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces create Create a new interface for the specified AWS private endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt b/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt index 11f4b27f..c68c1aa2 100644 --- a/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt +++ b/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces delete Remove the specified AWS private endpoint interface and related service from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt b/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt index 4c42cf4c..48c32510 100644 --- a/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt +++ b/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces describe Return the details for the specified AWS private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-aws-interfaces.txt b/source/command/atlas-privateEndpoints-aws-interfaces.txt index eefb5582..8f34b381 100644 --- a/source/command/atlas-privateEndpoints-aws-interfaces.txt +++ b/source/command/atlas-privateEndpoints-aws-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints aws interfaces Manage Atlas AWS private endpoint interfaces. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-aws-list.txt b/source/command/atlas-privateEndpoints-aws-list.txt index d73ffa7d..bb582ae1 100644 --- a/source/command/atlas-privateEndpoints-aws-list.txt +++ b/source/command/atlas-privateEndpoints-aws-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws list Return all AWS private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-aws-watch.txt b/source/command/atlas-privateEndpoints-aws-watch.txt index 2882272d..c033fc5d 100644 --- a/source/command/atlas-privateEndpoints-aws-watch.txt +++ b/source/command/atlas-privateEndpoints-aws-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws watch Watch the specified AWS private endpoint in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/source/command/atlas-privateEndpoints-aws.txt b/source/command/atlas-privateEndpoints-aws.txt index d761c7a4..9660c5ef 100644 --- a/source/command/atlas-privateEndpoints-aws.txt +++ b/source/command/atlas-privateEndpoints-aws.txt @@ -14,6 +14,13 @@ atlas privateEndpoints aws Manage AWS Private Endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-azure-create.txt b/source/command/atlas-privateEndpoints-azure-create.txt index 70c1bb7a..2e607398 100644 --- a/source/command/atlas-privateEndpoints-azure-create.txt +++ b/source/command/atlas-privateEndpoints-azure-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure create Create a new Azure private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-privateEndpoints-azure-delete.txt b/source/command/atlas-privateEndpoints-azure-delete.txt index d450ade5..868f4823 100644 --- a/source/command/atlas-privateEndpoints-azure-delete.txt +++ b/source/command/atlas-privateEndpoints-azure-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure delete Remove the specified Azure private endpoint from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-azure-describe.txt b/source/command/atlas-privateEndpoints-azure-describe.txt index 08ea4036..2c0d1076 100644 --- a/source/command/atlas-privateEndpoints-azure-describe.txt +++ b/source/command/atlas-privateEndpoints-azure-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure describe Return the details for the specified Azure private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-create.txt b/source/command/atlas-privateEndpoints-azure-interfaces-create.txt index 78aaaa41..c497a416 100644 --- a/source/command/atlas-privateEndpoints-azure-interfaces-create.txt +++ b/source/command/atlas-privateEndpoints-azure-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces create Create a new interface for the specified Azure private endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt b/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt index f09ff091..151746a4 100644 --- a/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt +++ b/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces delete Remove the specified Azure private endpoint interface and related service from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt index 886da083..ff5cfdfb 100644 --- a/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt +++ b/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -4,9 +4,6 @@ atlas privateEndpoints azure interfaces describe ================================================ -.. meta:: - :description: Retrieve details of a specified Azure private endpoint interface using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas privateEndpoints azure interfaces describe Return the details for the specified Azure private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-azure-interfaces.txt b/source/command/atlas-privateEndpoints-azure-interfaces.txt index 937d2aac..952c255d 100644 --- a/source/command/atlas-privateEndpoints-azure-interfaces.txt +++ b/source/command/atlas-privateEndpoints-azure-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints azure interfaces Manage Atlas Azure private endpoint interfaces. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-azure-list.txt b/source/command/atlas-privateEndpoints-azure-list.txt index 3564976b..096d98ab 100644 --- a/source/command/atlas-privateEndpoints-azure-list.txt +++ b/source/command/atlas-privateEndpoints-azure-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure list Return all Azure private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-azure-watch.txt b/source/command/atlas-privateEndpoints-azure-watch.txt index fa8ad3de..e0005181 100644 --- a/source/command/atlas-privateEndpoints-azure-watch.txt +++ b/source/command/atlas-privateEndpoints-azure-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure watch Watch the specified Azure private endpoint in your project until it becomes available. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/source/command/atlas-privateEndpoints-azure.txt b/source/command/atlas-privateEndpoints-azure.txt index 23b7368d..e73eb118 100644 --- a/source/command/atlas-privateEndpoints-azure.txt +++ b/source/command/atlas-privateEndpoints-azure.txt @@ -14,6 +14,13 @@ atlas privateEndpoints azure Manage Azure Private Endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-gcp-create.txt b/source/command/atlas-privateEndpoints-gcp-create.txt index 9da00080..5aa8f027 100644 --- a/source/command/atlas-privateEndpoints-gcp-create.txt +++ b/source/command/atlas-privateEndpoints-gcp-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp create Create a new GCP private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-delete.txt b/source/command/atlas-privateEndpoints-gcp-delete.txt index a9f0a427..6500572f 100644 --- a/source/command/atlas-privateEndpoints-gcp-delete.txt +++ b/source/command/atlas-privateEndpoints-gcp-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp delete Delete a GCP private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-describe.txt b/source/command/atlas-privateEndpoints-gcp-describe.txt index aa00926e..a699afa0 100644 --- a/source/command/atlas-privateEndpoints-gcp-describe.txt +++ b/source/command/atlas-privateEndpoints-gcp-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp describe Return a specific GCP private endpoint for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt b/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt index c88a7279..9d2f7694 100644 --- a/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt +++ b/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces create Create a GCP private endpoint interface. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt b/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt index f9513ead..a91ae03d 100644 --- a/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt +++ b/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces delete Delete a specific GCP private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt b/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt index db04731d..a938051c 100644 --- a/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt +++ b/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces describe Return a specific GCP private endpoint interface for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces.txt b/source/command/atlas-privateEndpoints-gcp-interfaces.txt index ec3ec345..828182a7 100644 --- a/source/command/atlas-privateEndpoints-gcp-interfaces.txt +++ b/source/command/atlas-privateEndpoints-gcp-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints gcp interfaces Manage Atlas GCP private endpoint interfaces. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-gcp-list.txt b/source/command/atlas-privateEndpoints-gcp-list.txt index 26f48fd7..bb887d3c 100644 --- a/source/command/atlas-privateEndpoints-gcp-list.txt +++ b/source/command/atlas-privateEndpoints-gcp-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp list List GCP private endpoints for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-privateEndpoints-gcp-watch.txt b/source/command/atlas-privateEndpoints-gcp-watch.txt index 5741d695..1fbb0b80 100644 --- a/source/command/atlas-privateEndpoints-gcp-watch.txt +++ b/source/command/atlas-privateEndpoints-gcp-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp watch Watch the specified GCP private endpoint to detect changes in the endpoint's state. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/source/command/atlas-privateEndpoints-gcp.txt b/source/command/atlas-privateEndpoints-gcp.txt index 29405adf..5f4d56f2 100644 --- a/source/command/atlas-privateEndpoints-gcp.txt +++ b/source/command/atlas-privateEndpoints-gcp.txt @@ -14,6 +14,13 @@ atlas privateEndpoints gcp Manage GCP private endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints-regionalModes-describe.txt b/source/command/atlas-privateEndpoints-regionalModes-describe.txt index ae3d9f7d..be827faf 100644 --- a/source/command/atlas-privateEndpoints-regionalModes-describe.txt +++ b/source/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -4,9 +4,6 @@ atlas privateEndpoints regionalModes describe ============================================= -.. meta:: - :description: Check the regionalized private endpoint setting for your project using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas privateEndpoints regionalModes describe Return the regionalized private endpoint setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Use this command to check whether you can create multiple private resources per region. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/source/command/atlas-privateEndpoints-regionalModes-disable.txt b/source/command/atlas-privateEndpoints-regionalModes-disable.txt index 77c5a220..0b0f0f65 100644 --- a/source/command/atlas-privateEndpoints-regionalModes-disable.txt +++ b/source/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -4,9 +4,6 @@ atlas privateEndpoints regionalModes disable ============================================ -.. meta:: - :description: Disable the regionalized private endpoint setting for a project in Atlas, requiring Project Owner role authentication. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas privateEndpoints regionalModes disable Disable the regionalized private endpoint setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This disables the ability to create multiple private resources per region in all cloud service providers for this project. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-privateEndpoints-regionalModes-enable.txt b/source/command/atlas-privateEndpoints-regionalModes-enable.txt index a2108f41..667c0826 100644 --- a/source/command/atlas-privateEndpoints-regionalModes-enable.txt +++ b/source/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -4,9 +4,6 @@ atlas privateEndpoints regionalModes enable =========================================== -.. meta:: - :description: Enable regionalized private endpoint settings in your project to create multiple private resources per region across cloud providers. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas privateEndpoints regionalModes enable Enable the regionalized private endpoint setting for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This enables the ability to create multiple private resources per region in all cloud service providers for this project. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-privateEndpoints-regionalModes.txt b/source/command/atlas-privateEndpoints-regionalModes.txt index 87c8064d..1314cd50 100644 --- a/source/command/atlas-privateEndpoints-regionalModes.txt +++ b/source/command/atlas-privateEndpoints-regionalModes.txt @@ -14,6 +14,13 @@ atlas privateEndpoints regionalModes Manage regionalized private endpoint setting for your Atlas project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-privateEndpoints.txt b/source/command/atlas-privateEndpoints.txt index eb0931fd..86ac946a 100644 --- a/source/command/atlas-privateEndpoints.txt +++ b/source/command/atlas-privateEndpoints.txt @@ -4,9 +4,6 @@ atlas privateEndpoints ====================== -.. meta:: - :description: Manage private endpoints in Atlas, including AWS, Azure, and GCP options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas privateEndpoints Manage Atlas private endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-processes-describe.txt b/source/command/atlas-processes-describe.txt index f5a2828c..064264d6 100644 --- a/source/command/atlas-processes-describe.txt +++ b/source/command/atlas-processes-describe.txt @@ -4,9 +4,6 @@ atlas processes describe ======================== -.. meta:: - :description: Retrieve details of a specific MongoDB process in your Atlas project using the CLI command `atlas processes describe`. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas processes describe Return the details for the specified MongoDB process for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-processes-list.txt b/source/command/atlas-processes-list.txt index e019a654..c488e2fc 100644 --- a/source/command/atlas-processes-list.txt +++ b/source/command/atlas-processes-list.txt @@ -4,9 +4,6 @@ atlas processes list ==================== -.. meta:: - :description: List all MongoDB processes for your project using the Atlas CLI, with options for output format, pagination, and project specification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas processes list Return all MongoDB processes for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-processes.txt b/source/command/atlas-processes.txt index ab19fbcb..866cb046 100644 --- a/source/command/atlas-processes.txt +++ b/source/command/atlas-processes.txt @@ -4,9 +4,6 @@ atlas processes =============== -.. meta:: - :description: Manage MongoDB processes for your project using the Atlas CLI, with options for help and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas processes Manage MongoDB processes for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-projects-apiKeys-assign.txt b/source/command/atlas-projects-apiKeys-assign.txt index e08d747c..c4fff007 100644 --- a/source/command/atlas-projects-apiKeys-assign.txt +++ b/source/command/atlas-projects-apiKeys-assign.txt @@ -14,6 +14,11 @@ atlas projects apiKeys assign Assign the specified organization API key to your project and modify the API key's roles for the project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. To view possible values for the ID argument, run atlas organizations apiKeys list. diff --git a/source/command/atlas-projects-apiKeys-create.txt b/source/command/atlas-projects-apiKeys-create.txt index 78b06bbe..91312ddc 100644 --- a/source/command/atlas-projects-apiKeys-create.txt +++ b/source/command/atlas-projects-apiKeys-create.txt @@ -14,6 +14,11 @@ atlas projects apiKeys create Create an organization API key and assign it to your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. If you don't provide an organization level role, the API Key defaults to organization member of the project parent organization. diff --git a/source/command/atlas-projects-apiKeys-delete.txt b/source/command/atlas-projects-apiKeys-delete.txt index e9df98b7..7501f8b5 100644 --- a/source/command/atlas-projects-apiKeys-delete.txt +++ b/source/command/atlas-projects-apiKeys-delete.txt @@ -4,9 +4,6 @@ atlas projects apiKeys delete ============================= -.. meta:: - :description: Remove an organization API key from a project using the Atlas CLI command `atlas projects apiKeys delete`. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects apiKeys delete Remove the specified organization API key from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The API key still exists at the organization level. To reassign the organization API key to a project, run the atlas projects apiKeys assign command. To view possible values for the ID argument, run atlas organizations apiKeys list. diff --git a/source/command/atlas-projects-apiKeys-list.txt b/source/command/atlas-projects-apiKeys-list.txt index c4b06853..41e8846d 100644 --- a/source/command/atlas-projects-apiKeys-list.txt +++ b/source/command/atlas-projects-apiKeys-list.txt @@ -4,9 +4,6 @@ atlas projects apiKeys list =========================== -.. meta:: - :description: List all organization API keys assigned to a project using the Atlas CLI, with options for output format, pagination, and project specification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects apiKeys list Return all organization API keys assigned to your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project User Admin role. Syntax diff --git a/source/command/atlas-projects-apiKeys.txt b/source/command/atlas-projects-apiKeys.txt index aa4c4c61..ba84de54 100644 --- a/source/command/atlas-projects-apiKeys.txt +++ b/source/command/atlas-projects-apiKeys.txt @@ -14,6 +14,13 @@ atlas projects apiKeys Manage API Keys for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-projects-create.txt b/source/command/atlas-projects-create.txt index 4b7609f9..f7dffbe5 100644 --- a/source/command/atlas-projects-create.txt +++ b/source/command/atlas-projects-create.txt @@ -4,9 +4,6 @@ atlas projects create ===================== -.. meta:: - :description: Create a project in your organization using the Atlas CLI, with options for region, output format, and alert settings. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects create Create a project in your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. diff --git a/source/command/atlas-projects-delete.txt b/source/command/atlas-projects-delete.txt index 840a40a2..1d2aaad0 100644 --- a/source/command/atlas-projects-delete.txt +++ b/source/command/atlas-projects-delete.txt @@ -14,6 +14,11 @@ atlas projects delete Remove the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-projects-describe.txt b/source/command/atlas-projects-describe.txt index 2d32ee6d..02dbf663 100644 --- a/source/command/atlas-projects-describe.txt +++ b/source/command/atlas-projects-describe.txt @@ -14,6 +14,11 @@ atlas projects describe Return the details for the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-projects-list.txt b/source/command/atlas-projects-list.txt index c83d0a8f..1993d5de 100644 --- a/source/command/atlas-projects-list.txt +++ b/source/command/atlas-projects-list.txt @@ -4,9 +4,6 @@ atlas projects list =================== -.. meta:: - :description: List all projects using the Atlas CLI with options for output format, pagination, and organization ID. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects list Return all projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/source/command/atlas-projects-settings-describe.txt b/source/command/atlas-projects-settings-describe.txt index 42972b04..01b89daa 100644 --- a/source/command/atlas-projects-settings-describe.txt +++ b/source/command/atlas-projects-settings-describe.txt @@ -4,9 +4,6 @@ atlas projects settings describe ================================ -.. meta:: - :description: Retrieve project settings details using the Atlas CLI with options for output format and project identification. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas projects settings describe Retrieve details for settings to the specified project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-projects-settings-update.txt b/source/command/atlas-projects-settings-update.txt index a2018163..b2351b43 100644 --- a/source/command/atlas-projects-settings-update.txt +++ b/source/command/atlas-projects-settings-update.txt @@ -4,9 +4,6 @@ atlas projects settings update ============================== -.. meta:: - :description: Update project settings in Atlas using various flags to enable or disable specific features. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas projects settings update Updates settings for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Syntax ------ diff --git a/source/command/atlas-projects-settings.txt b/source/command/atlas-projects-settings.txt index 86716637..6ba11106 100644 --- a/source/command/atlas-projects-settings.txt +++ b/source/command/atlas-projects-settings.txt @@ -14,6 +14,11 @@ atlas projects settings Settings operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Manage your project settings. Options diff --git a/source/command/atlas-projects-teams-add.txt b/source/command/atlas-projects-teams-add.txt index f8670378..7194a8c4 100644 --- a/source/command/atlas-projects-teams-add.txt +++ b/source/command/atlas-projects-teams-add.txt @@ -14,6 +14,11 @@ atlas projects teams add Add the specified team to your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + All members of the team share the same project access. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-projects-teams-delete.txt b/source/command/atlas-projects-teams-delete.txt index 1f5819a1..1f10432b 100644 --- a/source/command/atlas-projects-teams-delete.txt +++ b/source/command/atlas-projects-teams-delete.txt @@ -14,6 +14,11 @@ atlas projects teams delete Remove the specified team from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + After you remove a team from your project, the team still exists in the organization in which it was created. To use this command, you must authenticate with a user account or an API key with the Project User Admin role. diff --git a/source/command/atlas-projects-teams-list.txt b/source/command/atlas-projects-teams-list.txt index 12e530a7..8bd4385f 100644 --- a/source/command/atlas-projects-teams-list.txt +++ b/source/command/atlas-projects-teams-list.txt @@ -14,6 +14,11 @@ atlas projects teams list Return all teams for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-projects-teams-update.txt b/source/command/atlas-projects-teams-update.txt index 02527e0e..5090822f 100644 --- a/source/command/atlas-projects-teams-update.txt +++ b/source/command/atlas-projects-teams-update.txt @@ -14,6 +14,11 @@ atlas projects teams update Modify the roles for the specified team for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project User Admin role. Syntax diff --git a/source/command/atlas-projects-teams.txt b/source/command/atlas-projects-teams.txt index b215be21..7b11e7f1 100644 --- a/source/command/atlas-projects-teams.txt +++ b/source/command/atlas-projects-teams.txt @@ -14,6 +14,13 @@ atlas projects teams Manage your Atlas teams. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-projects-update.txt b/source/command/atlas-projects-update.txt index 88397c26..8c2d7cc1 100644 --- a/source/command/atlas-projects-update.txt +++ b/source/command/atlas-projects-update.txt @@ -4,9 +4,6 @@ atlas projects update ===================== -.. meta:: - :description: Update a project in Atlas using the CLI with options for configuration file and output format. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects update Update a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-projects-users-delete.txt b/source/command/atlas-projects-users-delete.txt index 870543b4..873b0416 100644 --- a/source/command/atlas-projects-users-delete.txt +++ b/source/command/atlas-projects-users-delete.txt @@ -14,6 +14,11 @@ atlas projects users delete Remove the specified user from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + After you remove a user from your project, the user still exists in the organization in which it was created. To use this command, you must authenticate with a user account or an API key with the Project User Admin role. diff --git a/source/command/atlas-projects-users-list.txt b/source/command/atlas-projects-users-list.txt index 8c446bcb..fadf573f 100644 --- a/source/command/atlas-projects-users-list.txt +++ b/source/command/atlas-projects-users-list.txt @@ -4,9 +4,6 @@ atlas projects users list ========================= -.. meta:: - :description: List all users for a specified project using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects users list Return all users for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-projects-users.txt b/source/command/atlas-projects-users.txt index 0292d114..072ab816 100644 --- a/source/command/atlas-projects-users.txt +++ b/source/command/atlas-projects-users.txt @@ -14,6 +14,13 @@ atlas projects users Manage users for a project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-projects.txt b/source/command/atlas-projects.txt index bc9dab84..c7ea4e83 100644 --- a/source/command/atlas-projects.txt +++ b/source/command/atlas-projects.txt @@ -4,9 +4,6 @@ atlas projects ============== -.. meta:: - :description: Manage Atlas projects with commands to create, list, update, and delete projects, and handle API keys, settings, teams, and users. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas projects Manage your Atlas projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your MongoDB projects. Options diff --git a/source/command/atlas-security-customerCerts-create.txt b/source/command/atlas-security-customerCerts-create.txt index 2b6ad22c..5d573b29 100644 --- a/source/command/atlas-security-customerCerts-create.txt +++ b/source/command/atlas-security-customerCerts-create.txt @@ -4,9 +4,6 @@ atlas security customerCerts create =================================== -.. meta:: - :description: Save a customer-managed X.509 configuration for your project using the Atlas CLI, triggering a rolling restart. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas security customerCerts create Saves a customer-managed X.509 configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Saving a customer-managed X.509 configuration triggers a rolling restart. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-security-customerCerts-describe.txt b/source/command/atlas-security-customerCerts-describe.txt index f1285240..73c488a5 100644 --- a/source/command/atlas-security-customerCerts-describe.txt +++ b/source/command/atlas-security-customerCerts-describe.txt @@ -4,9 +4,6 @@ atlas security customerCerts describe ===================================== -.. meta:: - :description: Retrieve details of the customer-managed X.509 configuration for your project using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas security customerCerts describe Return the details for the current customer-managed X.509 configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-security-customerCerts-disable.txt b/source/command/atlas-security-customerCerts-disable.txt index dcc41204..53f2727a 100644 --- a/source/command/atlas-security-customerCerts-disable.txt +++ b/source/command/atlas-security-customerCerts-disable.txt @@ -4,9 +4,6 @@ atlas security customerCerts disable ==================================== -.. meta:: - :description: Disable customer-managed X.509 settings on a project, including the Certificate Authority, using the Atlas CLI command. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas security customerCerts disable Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Disabling customer-managed X.509 triggers a rolling restart. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-security-customerCerts.txt b/source/command/atlas-security-customerCerts.txt index 9b8a81fb..f99bba7e 100644 --- a/source/command/atlas-security-customerCerts.txt +++ b/source/command/atlas-security-customerCerts.txt @@ -14,6 +14,13 @@ atlas security customerCerts Manage customer x509 certificates for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-security-ldap-delete.txt b/source/command/atlas-security-ldap-delete.txt index 1a260838..4fb081be 100644 --- a/source/command/atlas-security-ldap-delete.txt +++ b/source/command/atlas-security-ldap-delete.txt @@ -14,6 +14,11 @@ atlas security ldap delete Remove the current LDAP configuration captured in the userToDNMapping document from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-security-ldap-get.txt b/source/command/atlas-security-ldap-get.txt index 359a0931..faef6899 100644 --- a/source/command/atlas-security-ldap-get.txt +++ b/source/command/atlas-security-ldap-get.txt @@ -14,6 +14,11 @@ atlas security ldap get Return the current LDAP configuration details for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-security-ldap-save.txt b/source/command/atlas-security-ldap-save.txt index 8bae744b..ebc5e6ac 100644 --- a/source/command/atlas-security-ldap-save.txt +++ b/source/command/atlas-security-ldap-save.txt @@ -14,6 +14,11 @@ atlas security ldap save Save an LDAP configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-security-ldap-verify-status-watch.txt b/source/command/atlas-security-ldap-verify-status-watch.txt index 8a13c69d..3e578174 100644 --- a/source/command/atlas-security-ldap-verify-status-watch.txt +++ b/source/command/atlas-security-ldap-verify-status-watch.txt @@ -14,6 +14,11 @@ atlas security ldap verify status watch Watch for an LDAP configuration request to complete. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command checks the LDAP configuration's status periodically until it reaches a SUCCESS or FAILED status. Once the LDAP configuration reaches the expected status, the command prints "LDAP Configuration request completed." If you run the command in the terminal, it blocks the terminal session until the resource status succeeds or fails. diff --git a/source/command/atlas-security-ldap-verify-status.txt b/source/command/atlas-security-ldap-verify-status.txt index 3458531d..b419753a 100644 --- a/source/command/atlas-security-ldap-verify-status.txt +++ b/source/command/atlas-security-ldap-verify-status.txt @@ -14,6 +14,11 @@ atlas security ldap verify status Get the status of an LDAP configuration request. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-security-ldap-verify.txt b/source/command/atlas-security-ldap-verify.txt index 1a76e016..2ec1b45b 100644 --- a/source/command/atlas-security-ldap-verify.txt +++ b/source/command/atlas-security-ldap-verify.txt @@ -14,6 +14,11 @@ atlas security ldap verify Request verification of an LDAP configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-security-ldap.txt b/source/command/atlas-security-ldap.txt index 20627d14..ff9c4b1c 100644 --- a/source/command/atlas-security-ldap.txt +++ b/source/command/atlas-security-ldap.txt @@ -14,6 +14,13 @@ atlas security ldap LDAP operations. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-security.txt b/source/command/atlas-security.txt index 50d02b64..da1144d7 100644 --- a/source/command/atlas-security.txt +++ b/source/command/atlas-security.txt @@ -4,9 +4,6 @@ atlas security ============== -.. meta:: - :description: Manage security configurations for your project using the Atlas CLI, including options for help and profile selection. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,13 @@ atlas security Manage security configuration for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + + + Options ------- diff --git a/source/command/atlas-setup.txt b/source/command/atlas-setup.txt index 204a47ac..4b19fc3a 100644 --- a/source/command/atlas-setup.txt +++ b/source/command/atlas-setup.txt @@ -4,9 +4,6 @@ atlas setup =========== -.. meta:: - :description: Set up an Atlas cluster by registering, authenticating, creating, and accessing it using the Atlas CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas setup Register, authenticate, create, and access an Atlas cluster. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell. Syntax @@ -53,7 +55,7 @@ Options * - --connectWith - string - false - - Method for connecting to the cluster. Valid values are compass, mongosh and skip. + - Method for connecting to the cluster. Valid values are compass, mongosh, vscode and skip. Mutually exclusive with --skipMongosh. * - --currentIp diff --git a/source/command/atlas-streams-connections-create.txt b/source/command/atlas-streams-connections-create.txt index 41218f31..853805c5 100644 --- a/source/command/atlas-streams-connections-create.txt +++ b/source/command/atlas-streams-connections-create.txt @@ -14,6 +14,11 @@ atlas streams connections create Creates a connection for an Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-streams-connections-delete.txt b/source/command/atlas-streams-connections-delete.txt index 28a82a88..7ad329f3 100644 --- a/source/command/atlas-streams-connections-delete.txt +++ b/source/command/atlas-streams-connections-delete.txt @@ -14,6 +14,11 @@ atlas streams connections delete Remove the specified Atlas Stream Processing connection from your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-streams-connections-describe.txt b/source/command/atlas-streams-connections-describe.txt index 9c0081ac..3aa0a5b7 100644 --- a/source/command/atlas-streams-connections-describe.txt +++ b/source/command/atlas-streams-connections-describe.txt @@ -14,6 +14,11 @@ atlas streams connections describe Return the details for the specified Atlas Stream Processing connection. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-streams-connections-list.txt b/source/command/atlas-streams-connections-list.txt index 3acd0d2a..41ee6fc3 100644 --- a/source/command/atlas-streams-connections-list.txt +++ b/source/command/atlas-streams-connections-list.txt @@ -14,6 +14,11 @@ atlas streams connections list Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-streams-connections-update.txt b/source/command/atlas-streams-connections-update.txt index 12c4c249..ecd625b8 100644 --- a/source/command/atlas-streams-connections-update.txt +++ b/source/command/atlas-streams-connections-update.txt @@ -14,6 +14,11 @@ atlas streams connections update Modify the details of the specified connection within your Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-streams-connections.txt b/source/command/atlas-streams-connections.txt index 2c407450..cd3cafa2 100644 --- a/source/command/atlas-streams-connections.txt +++ b/source/command/atlas-streams-connections.txt @@ -14,6 +14,11 @@ atlas streams connections Manage Atlas Stream Processing connections. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list, update and delete your Atlas Stream Processing connections Options diff --git a/source/command/atlas-streams-instances-create.txt b/source/command/atlas-streams-instances-create.txt index d3058770..e1f3b620 100644 --- a/source/command/atlas-streams-instances-create.txt +++ b/source/command/atlas-streams-instances-create.txt @@ -4,9 +4,6 @@ atlas streams instances create ============================== -.. meta:: - :description: Create an Atlas Stream Processing instance by specifying a name, cloud provider, and region, requiring authentication with a Project Owner role. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas streams instances create Create an Atlas Stream Processing instance for your project +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing instance.To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/source/command/atlas-streams-instances-delete.txt b/source/command/atlas-streams-instances-delete.txt index f7e1a66a..940cf5bb 100644 --- a/source/command/atlas-streams-instances-delete.txt +++ b/source/command/atlas-streams-instances-delete.txt @@ -14,6 +14,11 @@ atlas streams instances delete Delete an Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The command prompts you to confirm the operation when you run the command without the --force option. Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. diff --git a/source/command/atlas-streams-instances-describe.txt b/source/command/atlas-streams-instances-describe.txt index e701019c..1f4c29d4 100644 --- a/source/command/atlas-streams-instances-describe.txt +++ b/source/command/atlas-streams-instances-describe.txt @@ -14,6 +14,11 @@ atlas streams instances describe Describe an Atlas Stream Processing instance for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-streams-instances-download.txt b/source/command/atlas-streams-instances-download.txt index 8cee843c..9407e81f 100644 --- a/source/command/atlas-streams-instances-download.txt +++ b/source/command/atlas-streams-instances-download.txt @@ -14,6 +14,11 @@ atlas streams instances download Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/source/command/atlas-streams-instances-list.txt b/source/command/atlas-streams-instances-list.txt index 43620f92..164d1dc3 100644 --- a/source/command/atlas-streams-instances-list.txt +++ b/source/command/atlas-streams-instances-list.txt @@ -14,6 +14,11 @@ atlas streams instances list List all the Atlas Stream Processing instances for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/source/command/atlas-streams-instances-update.txt b/source/command/atlas-streams-instances-update.txt index fb6875d5..edbbd29a 100644 --- a/source/command/atlas-streams-instances-update.txt +++ b/source/command/atlas-streams-instances-update.txt @@ -14,6 +14,11 @@ atlas streams instances update Updates an Atlas Stream Processing instance for your project. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Before updating an Atlas Streams Processing instance, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/source/command/atlas-streams-instances.txt b/source/command/atlas-streams-instances.txt index 88cb43a8..1d6cd3a2 100644 --- a/source/command/atlas-streams-instances.txt +++ b/source/command/atlas-streams-instances.txt @@ -14,6 +14,11 @@ atlas streams instances Manage Atlas Stream Processing instances. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list, update and delete your Atlas Stream Processing instances. Options diff --git a/source/command/atlas-streams-privateLinks-create.txt b/source/command/atlas-streams-privateLinks-create.txt index dcd556ed..24fbd53e 100644 --- a/source/command/atlas-streams-privateLinks-create.txt +++ b/source/command/atlas-streams-privateLinks-create.txt @@ -14,6 +14,11 @@ atlas streams privateLinks create Creates a PrivateLink endpoint that can be used as an Atlas Stream Processor connection. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax @@ -53,6 +58,10 @@ Options - string - false - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS or AZURE. This value defaults to "AZURE". Inherited Options ----------------- diff --git a/source/command/atlas-streams-privateLinks-delete.txt b/source/command/atlas-streams-privateLinks-delete.txt index 9d7ca42f..cec3782b 100644 --- a/source/command/atlas-streams-privateLinks-delete.txt +++ b/source/command/atlas-streams-privateLinks-delete.txt @@ -14,6 +14,11 @@ atlas streams privateLinks delete Deletes an Atlas Stream Processing PrivateLink endpoint. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/source/command/atlas-streams-privateLinks-describe.txt b/source/command/atlas-streams-privateLinks-describe.txt index 202502f7..aa3027e9 100644 --- a/source/command/atlas-streams-privateLinks-describe.txt +++ b/source/command/atlas-streams-privateLinks-describe.txt @@ -14,6 +14,11 @@ atlas streams privateLinks describe Describes a PrivateLink endpoint that can be used as an Atlas Stream Processor connection. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/source/command/atlas-streams-privateLinks-list.txt b/source/command/atlas-streams-privateLinks-list.txt index 064f1e9c..c3f132d6 100644 --- a/source/command/atlas-streams-privateLinks-list.txt +++ b/source/command/atlas-streams-privateLinks-list.txt @@ -14,6 +14,11 @@ atlas streams privateLinks list Lists the PrivateLink endpoints in the project that can be used as Atlas Stream Processor connections. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/source/command/atlas-streams-privateLinks.txt b/source/command/atlas-streams-privateLinks.txt index 47740b5d..1665d312 100644 --- a/source/command/atlas-streams-privateLinks.txt +++ b/source/command/atlas-streams-privateLinks.txt @@ -14,6 +14,11 @@ atlas streams privateLinks Manage Atlas Stream Processing PrivateLink endpoints. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create your Atlas Stream Processing PrivateLink endpoints Options diff --git a/source/command/atlas-streams.txt b/source/command/atlas-streams.txt index 03525f5b..5a458be2 100644 --- a/source/command/atlas-streams.txt +++ b/source/command/atlas-streams.txt @@ -4,9 +4,6 @@ atlas streams ============= -.. meta:: - :description: Manage Atlas Stream Processing deployments by creating, editing, and deleting streams, and modifying connection registries. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas streams Manage your Atlas Stream Processing deployments. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The streams command provides access to your Atlas Stream Processing configurations. You can create, edit, and delete streams, as well as change the connection registry. Options diff --git a/source/command/atlas-teams-create.txt b/source/command/atlas-teams-create.txt index 9bb80753..83bfc9fc 100644 --- a/source/command/atlas-teams-create.txt +++ b/source/command/atlas-teams-create.txt @@ -14,6 +14,11 @@ atlas teams create Create a team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/source/command/atlas-teams-delete.txt b/source/command/atlas-teams-delete.txt index 3be0a283..d75e4b6c 100644 --- a/source/command/atlas-teams-delete.txt +++ b/source/command/atlas-teams-delete.txt @@ -14,6 +14,11 @@ atlas teams delete Remove the specified team from your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/source/command/atlas-teams-describe.txt b/source/command/atlas-teams-describe.txt index a61464ad..ca91b21d 100644 --- a/source/command/atlas-teams-describe.txt +++ b/source/command/atlas-teams-describe.txt @@ -14,6 +14,11 @@ atlas teams describe Return the details for the specified team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can return the details for a team using the team's ID or the team's name. You must specify either the id option or the name option. To use this command, you must authenticate with a user account or an API key with the Organization Member role. @@ -47,10 +52,14 @@ Options - string - false - Unique 24-digit string that identifies the team. + + Mutually exclusive with --name. * - --name - string - false - Label that identifies the team. + + Mutually exclusive with --id. * - --orgId - string - false diff --git a/source/command/atlas-teams-list.txt b/source/command/atlas-teams-list.txt index a30efdf9..dd50da86 100644 --- a/source/command/atlas-teams-list.txt +++ b/source/command/atlas-teams-list.txt @@ -4,9 +4,6 @@ atlas teams list ================ -.. meta:: - :description: List all teams in your organization using the Atlas CLI command with various output and pagination options. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas teams list Return all teams for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-teams-rename.txt b/source/command/atlas-teams-rename.txt index 867a75b2..4579c28d 100644 --- a/source/command/atlas-teams-rename.txt +++ b/source/command/atlas-teams-rename.txt @@ -14,6 +14,11 @@ atlas teams rename Rename a team in your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/source/command/atlas-teams-users-add.txt b/source/command/atlas-teams-users-add.txt index eeb63198..355c84ab 100644 --- a/source/command/atlas-teams-users-add.txt +++ b/source/command/atlas-teams-users-add.txt @@ -14,6 +14,11 @@ atlas teams users add Add the specified MongoDB user to a team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can add users that are part of the organization or users that have been sent an invitation to join the organization. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/source/command/atlas-teams-users-delete.txt b/source/command/atlas-teams-users-delete.txt index 4cd64e07..bd9495fb 100644 --- a/source/command/atlas-teams-users-delete.txt +++ b/source/command/atlas-teams-users-delete.txt @@ -14,6 +14,11 @@ atlas teams users delete Remove the specified user from a team for your organization. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/source/command/atlas-teams-users-list.txt b/source/command/atlas-teams-users-list.txt index ae494e02..6c24a4fd 100644 --- a/source/command/atlas-teams-users-list.txt +++ b/source/command/atlas-teams-users-list.txt @@ -14,6 +14,11 @@ atlas teams users list Return all users for a team. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/source/command/atlas-teams-users.txt b/source/command/atlas-teams-users.txt index d8724b07..1da6bd8d 100644 --- a/source/command/atlas-teams-users.txt +++ b/source/command/atlas-teams-users.txt @@ -14,6 +14,11 @@ atlas teams users Manage your Atlas users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your users. Options diff --git a/source/command/atlas-teams.txt b/source/command/atlas-teams.txt index d4d2f99a..fb5675a7 100644 --- a/source/command/atlas-teams.txt +++ b/source/command/atlas-teams.txt @@ -4,9 +4,6 @@ atlas teams =========== -.. meta:: - :description: Manage Atlas teams by creating, listing, renaming, and deleting them using the CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas teams Manage your Atlas teams. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create, list and manage your Atlas teams. Options diff --git a/source/command/atlas-users-describe.txt b/source/command/atlas-users-describe.txt index 4ec47d18..039d628e 100644 --- a/source/command/atlas-users-describe.txt +++ b/source/command/atlas-users-describe.txt @@ -14,6 +14,11 @@ atlas users describe Return the details for the specified Atlas user. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + You can specify either the unique 24-digit ID that identifies the Atlas user or the username for the Atlas user. User accounts and API keys with any role can run this command. diff --git a/source/command/atlas-users-invite.txt b/source/command/atlas-users-invite.txt index 22121894..f2b35160 100644 --- a/source/command/atlas-users-invite.txt +++ b/source/command/atlas-users-invite.txt @@ -4,9 +4,6 @@ atlas users invite ================== -.. meta:: - :description: Invite users to your Atlas organizations and projects by creating an Atlas user account with specified roles and permissions. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas users invite Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create. Syntax diff --git a/source/command/atlas-users.txt b/source/command/atlas-users.txt index d109974d..08d05884 100644 --- a/source/command/atlas-users.txt +++ b/source/command/atlas-users.txt @@ -4,9 +4,6 @@ atlas users =========== -.. meta:: - :description: Manage Atlas users by creating, describing, and inviting them to organizations and projects using the CLI. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas users Manage your Atlas users. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Create and manage your Atlas users. Options diff --git a/source/command/atlas.txt b/source/command/atlas.txt index d496d854..a19aa90b 100644 --- a/source/command/atlas.txt +++ b/source/command/atlas.txt @@ -4,9 +4,6 @@ atlas ===== -.. meta:: - :description: Manage MongoDB Atlas deployments and search using the Atlas CLI with intuitive terminal commands. - .. default-domain:: mongodb .. contents:: On this page @@ -17,6 +14,11 @@ atlas CLI tool to manage MongoDB Atlas. +Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + The Atlas CLI is a command line interface built specifically for MongoDB Atlas. You can manage your Atlas database deployments and Atlas Search from the terminal with short, intuitive commands. Use the --help flag with any command for more info on that command. @@ -56,7 +58,7 @@ Related Commands * :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. * :ref:`atlas-accessLogs` - Return the access logs for a cluster. * :ref:`atlas-alerts` - Manage alerts for your project. -* :ref:`atlas-api` - Public Preview: please provide feedback at : Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +* :ref:`atlas-api` - `Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. * :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. * :ref:`atlas-auth` - Manage the CLI's authentication state. * :ref:`atlas-backups` - Manage cloud backups for your project.