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 >
  • Configure API Access

Configure API Access

On this page

To access the Ops Manager API, you must generate an API key for programmatic access for an organization.

API Keys can’t use the Ops Manager Console

Organization-based API Keys aren’t associated with user credentials. You can’t use these API Keys to log in to the Ops Manager console.

Prerequisite

Enable API Whitelisting for Your Organization

For Ops Manager users with a non-empty API whitelist, all API access must originate from a whitelisted IPv4 address. Ensure your configured whitelist entries provide appropriate coverage for all clients which require API access. An empty API whitelist grants access to all API endpoints except those that explicitly require whitelisting.

Ops Manager supports requiring API whitelisting at the organization level, such that any API activity for all projects within that organization must originate from an entry on each respective Ops Manager user’s API whitelist. For organizations that require API whitelisting, Ops Manager users cannot access any API operations until they define at least one API whitelist entry.

To require an API whitelist for an Organization:

  1. Log into Ops Manager.
  2. Access the Organization using the Context picker in the top-left hand corner of the Ops Manager UI.
  3. Click Settings from the left hand navigation.
  4. Toggle the Require IP Whitelist for Public API setting to On.

Manage Access to the API

You can set API Keys for an entire organization or project.

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