atlas api projects listProjects
Public Preview: please provide feedback at: Returns details about all projects.
Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Organization Read Only role or higher.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api projects listProjects [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | envelope | false | Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
-h, --help | false | help for listProjects | |
--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 <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> 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". |
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. |
Examples
Get a list of all projects inside of the organisation
Run the command below.
atlas api projects listProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false