Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas serverless describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Return one serverless instance in the specified project.

To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Command Syntax
atlas serverless describe <instanceName> [options]
Name
Type
Required
Description
instanceName
string
true
Human-readable label that identifies your serverless instance.
Name
Type
Required
Description
-h, --help
false
help for describe
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

ID NAME MDB VER STATE
<Id> <Name> <MongoDBVersion> <StateName>
← delete
list →