Manage Agent API Keys
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Overview
Note
New Agent API Keys Model
With the new Agent API Key model, multiple Agent API Keys can be associated with a project. This gives users the ability to perform Agent key rotation.
In addition, the new Agent API Key model improves on security as the keys are displayed only once upon creation and Cloud Manager no longer stores or displays these keys.
An Agent API key is a unique identifier that the Automation, Monitoring, and Backup Agents for a project use to authenticate themselves to Cloud Manager. A project can have multiple Agent API keys. Any of the project's agents can use any of the Agent API keys associated with the project.
View Agent API Keys
For keys created using the new Agent API Key Model, you can manage your Agent API keys from the Agent API Keys tab.
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Agents page.
Click the Agents tab for your deployment.
The Agents page displays.
The tab displays a list of existing Agent API keys. The keys themselves are redacted. However, the list displays the description and creation details.
Create Agent API Key
Note
Only the project's owner can create an Agent API key. You can generate an Agent API Key while installing an agent if you are the project owner and the project has either no Agent API keys or just the Original Group API key.
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Agents page.
Click the Agents tab for your deployment.
The Agents page displays.
Copy and record the key.
Copy and record the key when it is generated.
Important
When you generate an Agent API Key, Cloud Manager displays it one time only. You must copy this key. Treat it like a password; store it in a secure place. Cloud Manager never displays the full key again.
After you have recorded the key, click Close.
Delete Agent API Key
Note
Only the project's owner can delete an Agent API key.
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Agents page.
Click the Agents tab for your deployment.
The Agents page displays.