Navigation

mongocli iam project describe

The mongocli iam project describe command retrieves the details of a project in your Atlas, Cloud Manager or Ops Manager instance.

You can also describe projects through the API for each service:

mongocli iam project|projects describe|show
<project-id>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
Note

Use -h or --help to view the command-line help for this command.

Argument
Type
Description
Required?
<project-id>
string
Unique identifier of the project you want to describe.
yes
Option
Type
Description
Required?
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using the Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string

Name of the profile where your credentials are saved.

If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.

no

If the command succeeds, it prints the following fields in JSON format. The fields returned depend on your MongoDB service. If the command returns errors, see Troubleshooting for recommended solutions.

Field
Description
clusterCount
The number of Atlas clusters deployed in the project.
created
The ISO-8601-formatted timestamp of when Atlas created the project.
id
The unique identifier of the project.
links
Array of one or more links to sub-resources and/or related resources. The relations between URL s are explained in the Web Linking Specification.
name
The name of the project.
orgId
The unique identifier of the organization to which the project belongs.

The following mongocli iam project describe command describes an Atlas project using the default profile.

mongocli iam project describe 5e2f04abc10fab99c7d4072e --output json

The command returns the following JSON document:

{
"id": "5e2f04abc10fab99c7d4072e",
"orgId": "5df27c15f10fab55fc6c1234",
"name": "Project1",
"clusterCount": 1,
"created": "2020-01-27T15:42:39Z",
"links": [
{
"rel": "self",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e"
},
{
"rel": "http://mms.mongodb.com/containers",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e/containers"
},
{
"rel": "http://mms.mongodb.com/clusters",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e/clusters"
},
{
"rel": "http://mms.mongodb.com/databaseUsers",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e/databaseUsers"
},
{
"rel": "http://mms.mongodb.com/peers",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e/peers"
},
{
"rel": "http://mms.mongodb.com/processes",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e/processes"
},
{
"rel": "http://mms.mongodb.com/whitelist",
"href": "https://example.mongodb.com/api/atlas/v1.0/groups/5e2f04ecf10fab66c7d4072e/whitelist"
}
]
}
Give Feedback