Docs Home → MongoDB Command Line Interface
mongocli iam globalApiKeys describe
On this page
Return the details for the specified global API key for your Ops Manager instance.
Syntax
mongocli iam globalApiKeys describe <ID> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
ID | string | true | Unique 24-digit string that identifies the global API key. |
Options
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. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Return the JSON-formatted details for the global API key with the ID 5f5bad7a57aef32b04ed0210: mongocli iam globalApiKeys describe 5f5bad7a57aef32b04ed0210 --output json