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.

Organization API Keys on Projects

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Use the following resources to view, create and assign, or unassign Organization programmatic API Keys within the specified Ops Manager project.

Permissions

To use these endpoints, grant the following roles to an Project API Key or user in your Organization:

Role Possible Action
Any role in the Project Retrieve Project API Keys
Project Owner or Project User Admin Create, update, or delete a Project API Key
Project Owner or Project User Admin Assign or unassign an Organization API Key to a Project

Endpoints

Method Endpoint Description
GET /groups/{PROJECT-ID}/apiKeys Get All Organization API Keys Assigned to One Project with ID {GROUP_ID}.
PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID} Modify Roles of One Organization API Key with ID {API-KEY-ID} assigned to One Project with ID {PROJECT-ID}.
POST /groups/{PROJECT-ID}/apiKeys Create and Assign One Organization API Key with ID {API-KEY-ID} to One Project with ID {PROJECT-ID}.
PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID} Assign One Existing Organization API Key with ID {API-KEY-ID} to One Project with ID {PROJECT-ID}.
DELETE /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID} Unassign One Organization API Key with ID {API-KEY-ID} from One Project.