atlas api organizations listOrganizationProjects
On this page
experimental: Returns multiple projects in the specified organization.
Each organization can have multiple projects. Use projects to:
Isolate different environments, such as development, test, or production environments, from each other. Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments. Maintain separate cluster security configurations. Create different alert settings. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects
Syntax
atlas api organizations listOrganizationProjects [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
-h, --help | false | help for listOrganizationProjects | |
--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 |
--name | string | false | human-readable label of the project to use to filter the returned list |
--orgId | string | true | unique 24-hexadecimal digit string that identifies the organization that contains your projects |
--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". |
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. |