Returns the details for one Atlas Ephemeral cluster.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
To learn more about Ephemeral clusters, see Create an Atlas Ephemeral Cluster in the MongoDB Atlas documentation.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getephemeralcluster.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api ephemeralClusters getEphemeralCluster [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterId | string | true | Unique ID of the ephemeral cluster to look up. |
-h, --help | false | help for getEphemeralCluster | |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | 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) |
--version | string | false | API version to use when calling the Atlas API endpoints [options: "preview"]. If not set by the user, defaults to the latest version or the profile's api_version config value if set. This value defaults to "preview". |
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. |