Organization Programmatic API Keys

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.: The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.

Use the /orgs/{ORG-ID}/apiKeys resource to view, create, or delete Programmatic |api| Keys within the specified Cloud Manager organization.

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 Organization	Retrieve Organization API Keys
`Organization Owner` or `Organization User Admin`	Create, update, or delete a Organization API Key

Method	Endpoint	Description
`GET`	/orgs/{ORG-ID}/apiKeys	Get all API Keys for the organization identified with `{ORG-ID}`.
`GET`	/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}	Get one API Key for the organization identified with `{ORG-ID}`.
`POST`	/orgs/{ORG-ID}/apiKeys	Create an API Key for the organization identified with `{ORG-ID}`.
`PATCH`	/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}	Update one API Key for the organization identified with `{ORG-ID}`.
`DELETE`	/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}	Delete the API Key with ID `{API-KEY-ID}`.

Back

Programmatic API Keys

Create