atlas clusters onlineArchives list
On this page
Return all online archives for your cluster.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
atlas clusters onlineArchives list [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. |
-h, --help | 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 | 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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID DATABASE COLLECTION STATE <Id> <DbName> <CollName> <State>
Examples
# Return a JSON-formatted list of online archives for the cluster named myCluster: atlas clusters onlineArchives list --clusterName myCluster --output json