atlas api
On this page
experimental: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for api |
Inherited Options
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. |
Related Commands
atlas api accessTracking - experimental: Returns access logs for authentication attempts made to Atlas database deployments.
atlas api alertConfigurations - experimental: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
atlas api alerts - experimental: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.
atlas api atlasSearch - experimental: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster.
atlas api auditing - experimental: Returns and edits database auditing settings for MongoDB Cloud projects.
atlas api awsClustersDns - experimental: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS.
atlas api cloudBackups - experimental: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules.
atlas api cloudMigrationService - experimental: Manages the Cloud Migration Service.
atlas api cloudProviderAccess - experimental: Returns, adds, authorizes, and removes AWS IAM roles in Atlas.
atlas api clusterOutageSimulation - experimental: Returns, starts, or ends a cluster outage simulation.
atlas api clusters - experimental: Returns, adds, edits, and removes database deployments.
atlas api collectionLevelMetrics - experimental: Returns, adds, and edits pinned namespaces for the specified cluster or process.
atlas api customDatabaseRoles - experimental: Returns, adds, edits, and removes custom database user privilege roles.
atlas api dataFederation - experimental: Returns, adds, edits, and removes Federated Database Instances.
atlas api dataLakePipelines - experimental: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.
atlas api databaseUsers - experimental: Returns, adds, edits, and removes database users.
atlas api encryptionAtRestUsingCustomerKeyManagement - experimental: Returns and edits the Encryption at Rest using Customer Key Management configuration.
atlas api events - experimental: Returns events.
atlas api federatedAuthentication - experimental: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
atlas api flexClusters - experimental: Returns, adds, edits, and removes flex clusters.
atlas api flexRestoreJobs - experimental: Returns and adds restore jobs for flex database deployments.
atlas api flexSnapshots - experimental: Returns and requests to download flex database deployment snapshots.
atlas api globalClusters - experimental: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.
atlas api invoices - experimental: Returns invoices.
atlas api ldapConfiguration - experimental: Returns, edits, verifies, and removes LDAP configurations.
atlas api legacyBackup - experimental: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.
atlas api maintenanceWindows - experimental: Returns, edits, and removes maintenance windows.
atlas api mongoDbCloudUsers - experimental: Returns, adds, and edits MongoDB Cloud users.
atlas api monitoringAndLogs - experimental: Returns database deployment monitoring and logging data.
atlas api networkPeering - experimental: Returns, adds, edits, and removes network peering containers and peering connections.
atlas api onlineArchive - experimental: Returns, adds, edits, or removes an online archive.
atlas api openApi - experimental: Returns information about the MongoDB Atlas Specification.
atlas api organizations - experimental: Returns, adds, and edits organizational units in MongoDB Cloud.
atlas api performanceAdvisor - experimental: Returns suggested indexes and slow query data for a database deployment.
atlas api privateEndpointServices - experimental: Returns, adds, edits, and removes private endpoint services.
atlas api programmaticApiKeys - experimental: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API.
atlas api projectIpAccessList - experimental: Returns, adds, edits, and removes network access limits to database deployments in Atlas.
atlas api projects - experimental: Returns, adds, and edits collections of clusters and users in MongoDB Cloud.
atlas api pushBasedLogExport - experimental: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket.
atlas api resourcePolicies - experimental: Configure and manage Atlas Resource Policies within your organization.
atlas api rollingIndex - experimental: Creates one index to a database deployment in a rolling manner.
atlas api root - experimental: Returns details that describe the MongoDB Cloud build and the access token that requests this resource.
atlas api serverlessInstances - experimental: Returns, adds, edits, and removes serverless instances.
atlas api serverlessPrivateEndpoints - experimental: Returns, adds, edits, and removes private endpoints for serverless instances.
atlas api serviceAccounts - experimental: Endpoints for managing Service Accounts and secrets.
atlas api sharedTierRestoreJobs - experimental: Returns and adds restore jobs for shared-tier database deployments.
atlas api sharedTierSnapshots - experimental: Returns and requests to download shared-tier database deployment snapshots.
atlas api streams - experimental: Returns, adds, edits, and removes Streams Instances.
atlas api teams - experimental: Returns, adds, edits, or removes teams.
atlas api test - experimental: Atlas test endpoints.
atlas api thirdPartyIntegrations - experimental: Returns, adds, edits, and removes third-party service integration configurations.
atlas api x509Authentication - experimental: Returns, edits, and removes user-managed X.509 configurations.