Navigation

Programmatic API Keys

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Use the following resources to view, create, or delete programmatic API Keys within the specified Atlas organization.

Users with the Organization Owner role in the organization associated with the API Key can use the Organization API Key to access these endpoints.

MethodEndpointDescription
GET/orgs/{ORG-ID}/apiKeysGet all Organization API Keys associated with {ORG-ID}.
GET/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}Get one Organization API Key.
PATCH/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}Update an Organization API Key.
POST/orgs/{ORG-ID}/apiKeysCreate an Organization API Key for the specified organization.
DELETE/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}Delete the Organization API Key with ID {API-KEY-ID}.

Use the following resources to view, create, and update access lists for Organization programmatic API Keys.

Users with the Organization Owner role in the organization associated with the API Key can use the Organization API Key to access these endpoints.

MethodEndpointDescription
GET/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslistGet all API Key access list entries that belong to {API-KEY-ID}.
GET/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist/{IP-ADDRESS}Get the API Key access list entry for {API-KEY-ID} specified by {IP-ADDRESS}.
POST/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslistCreate one or more API Key access list entries for {API-KEY-ID}.
DELETE/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist/{IP-ADDRESS}Delete the API Key access list entry for {API-KEY-ID} specified by {IP-ADDRESS}.

Atlas deprecated these endpoints. Use Organization API Key Access List Endpoints instead.

MethodEndpointDescription
GET/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelistGet all whitelist entries that belong to {API-KEY-ID}.
GET/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/{IP-ADDRESS}Get the whitelist entry for {API-KEY-ID} specified by {IP-ADDRESS}.
POST/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelistCreate one or more whitelist entries for {API-KEY-ID}.
DELETE/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/{IP-ADDRESS}Delete the whitelist entry for {API-KEY-ID} specified by {IP-ADDRESS}.

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

Users with the Project Owner role in the project associated with the API Key can use the Organization API Key to access these endpoints.

MethodEndpointDescription
GET/groups/{GROUP-ID}/apiKeysGet All Organization API Keys Assigned to One Project with ID {GROUP_ID}.
PATCH/groups/{GROUP-ID}/apiKeys/{API-KEY-ID}Modify Roles of One Organization API Key to One Project.
POST/groups/{GROUP-ID}/apiKeysCreate and Assign One Organization API Key to One Project.
PATCH/groups/{GROUP-ID}/apiKeys/{API-KEY-ID}Assign One Organization API Key to One Project.
DELETE/groups/{GROUP-ID}/apiKeys/{API-KEY-ID}Unassign One Organization API Key ({API-KEY-ID}) from One Project.
Give Feedback