Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli iam globalApiKeys describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Return the details for the specified global API key for your Ops Manager instance.

Command Syntax
mongocli iam globalApiKeys describe <ID> [options]
Name
Type
Required
Description
ID
string
true
Unique 24-digit string that identifies the global API key.
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.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.
# Return the JSON-formatted details for the global API key with the ID 5f5bad7a57aef32b04ed0210:
mongocli iam globalApiKeys describe 5f5bad7a57aef32b04ed0210 --output json
←  mongocli iam globalApiKeys deletemongocli iam globalApiKeys list →