Docs Menu
Docs Home
/
MongoDB Ops Manager
/

Configure API Access

On this page

  • Prerequisite
  • Manage Access to the API

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

Note

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.

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

Ops Manager supports requiring an API access list 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 access list. For organizations that require an API access list, Ops Manager users cannot access any API operations until they define at least one API access list entry.

To require an API access list 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 Access List for Ops Manager Administration API setting to On.

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

← Ops Manager Administration API Error Codes