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 >
  • Enable the Public API

Enable the Public API

On this page

Overview

You enable the Public API on a per-group basis. To enable the Public API, you must have the Owner role for the group or have the Global Owner role Ops Manager.

Once you have enabled the Public API, users who want to use the API must generate their own API keys and optionally configure access to whitelisted operations. See Configure Public API Access. A user’s roles determine which API resources the user can access.

For a description of the Public API, see the Public API Principles.

Procedure

For each group that will use the Public API, do the following:

1

Select the Settings tab and then select Group Settings.

2

Toggle the Enable Public API field to ON.

An API Key is like a password. Keep it secret.

To generate a key, select the Settings tab and then Public API Access. In the API Keys section, use the Generate button to generate a new key. Follow the prompts, being sure to copy the key once it is generated. Ops Manager displays the full key one time only. Ops Manager displays only the partial key in the key list and provides no access to the full key.

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