Docs Home → MongoDB Command Line Interface
mongocli atlas clusters onlineArchives describe
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Return the details for the specified online archive for your cluster.
To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.
Syntax
Command Syntax
mongocli atlas clusters onlineArchives describe <archiveId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
archiveId | string | true | Unique identifier of the online archive to retrieve. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. |
-h, --help | false | help for describe | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID CLUSTER DATABASE COLLECTION STATE <Id> <ClusterName> <DbName> <CollName> <State>
Examples
# Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: mongocli atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json