atlas api onlineArchive listOnlineArchives

On this page

experimental: Returns details of all online archives.

This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listOnlineArchives'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives

Syntax

Command Syntax

atlas api onlineArchive listOnlineArchives [options]

Name	Type	Required	Description
--clusterName	string	true	human-readable label that identifies the cluster that contains the collection for which you want to return the online archives
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for listOnlineArchives
--includeCount		false	flag that indicates whether the response returns the total number of items (totalCount) in the response
--itemsPerPage	int	false	number of items that the response returns per page
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pageNum	int	false	number of the page that displays the current set of the total objects that the response returns
--pretty		false	flag that indicates whether the response body should be in the prettyprint format
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

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.

Back

getOnlineArchive

updateOnlineArchive