atlas api clusters listClusters
On this page
experimental: 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. This command is invoking the endpoint with OperationID: 'listClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters
Syntax
atlas api clusters listClusters [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--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 listClusters | |
--includeCount | false | flag that indicates whether the response returns the total number of items (totalCount) in the response | |
--includeDeletedWithRetainedBackups | false | flag that indicates whether to return Clusters with retain backups | |
--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", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". |
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. |