mongocli ops-manager agents apikey create
The agents apikey create command creates one agent API key for
the specified Ops Manager project.
You must have GROUP_OWNER privileges for a project to create an
agent API key for that project.
Syntax
mongocli ops-manager|om agents apikey|apikeys create -- desc <description of the agent API key> [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <id-of-project> ]
Options
Option | Type | Description | Required? |
|---|---|---|---|
--desc | string | Description of the agent API key. | yes |
--output, -o | string | Command output format. Valid values are:
If omitted, the command returns output in the default format. | no |
--profile, -P | string | Name of the profile where the public and private
keys for the project are saved. If omitted, uses the
default profile. To learn more about creating a
profile, see Configure the MongoDB CLI. | no |
--projectId | string | Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable. | no |
Output
If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.
Warning
MongoDB CLI returns the agent API key only once. After running this command, immediately copy, save, and secure the agent API key.
API Key '<agent-api-key>' created.
The default output is a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the Public API reference for your MongoDB service:
Example
The following command creates one agent API key for a project using the default profile, which contains credentials and the project ID. The output is returned in the default format.
mongocli om agents apikey create --desc agentKey
The previous command prints the following to the terminal.
Warning
MongoDB CLI returns the agent API key only once. After running this command, immediately copy, save, and secure the agent API key.
API Key '5f4944e7c90220199059813f0cf83079032a0f7f9538a2f69562a93a' created.
The following command creates one agent API key for a project using the default profile, which contains credentials and the project ID. The output is returned in JSON format.
mongocli om agents apikey create --desc agentKey --output json
The previous command prints the following to the terminal in JSON format.
Warning
MongoDB CLI returns the agent API key only once. After running this command, immediately copy, save, and secure the agent API key.
{ "_id": "5f49471dc90220199059861c", "key": "5f49471dc90220199059861cb3e32a61a5ceeb1f5d958d2be0954acc", "desc": "agentKey", "createdTime": 1598637853857, "createdUserId": "5f36b26fc902201990297b3b", "createdIpAddr": "127.0.0.1", "createdBy": "PUBLIC_API" }