Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

API Keys

On this page

This page lists the available Global API Keys for this Ops Manager instance. You can:

  • Search for an API Key,
  • Add new API Keys,
  • Edit existing API Keys, or
  • Delete existing API Keys.

Note

Ops Manager limits all actions in this section to users or Global API Keys that were granted the Global Owner role.

Add a Global API Key

  1. Click Create API Key to open the Add API Key page.

  2. At the Enter API Key Information step, set both required values in the Global API Key form:

    Description Type the purpose this Global API Key serves. This description can’t be longer than 250 characters.
    Global Permissions Select the new role or roles to be assigned to the API Key.

    Ops Manager generates the Public Key at this step.

  3. Click Next.

  4. At the Private Key step, click the Copy button to add the Private Key to the clipboard. Save and secure this Private Key as you would any other password. To use your Global API Key with the Ops Manager API, you need both the public key, which serves as a username, and the private key, which serves as a password.

    Warning

    Copy your full private key at this point. Store it in a secure location. Ops Manager doesn’t and can’t display the full private key after you leave this page.

  5. To add an access list entry, click Go to Global Access List.

  6. Click Done.

Edit a Global API Key

Warning

Once saved, any changes to these permissions impact applications that use this Global API Key.

  1. To the right of the Global API Key that you want to edit, click ellipsis icon then select Edit API Key to open the Edit Global API Key modal. Ops Manager displays the Public Key in this modal.

  2. Change the values in the Global API Key form as needed:

    Description Type the purpose this Global API Key serves. This description can’t be longer than 250 characters.
    Global Permissions Select the new role or roles to be assigned to the API Key.

  3. Click Save if you made changes to your Global API Key. Click Cancel to close the page without editing the Global API Key.

Delete a Global API Key

Warning

Deleting a Global API Key might impact applications that use that key.

  1. To the right of the Global API Key that you want to delete, click ellipsis icon then select Delete API Key to open the Delete Global API Key modal.
  2. Type the public key for the Global API Key in the box to confirm that you want to delete this key.
  3. Click Delete to delete your Global API Key. Click Cancel to close the modal without deleting the Global API Key.
←   Users Global Access List  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.