Programmatic API Keys¶
On this page
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Organization API Key Endpoints¶
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.
Method | Endpoint | Description |
---|---|---|
GET | Get all Organization API Keys associated with {ORG-ID} . | |
GET | Get one Organization API Key. | |
PATCH | Update an Organization API Key. | |
POST | Create an Organization API Key for the specified organization. | |
DELETE | Delete the Organization API Key with ID {API-KEY-ID} . |
Organization API Key Access List Endpoints¶
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.
Method | Endpoint | Description |
---|---|---|
GET | Get all API Key access list entries that belong to
{API-KEY-ID} . | |
GET | Get the API Key access list entry for {API-KEY-ID} specified
by {IP-ADDRESS} . | |
POST | Create one or more API Key access list entries for
{API-KEY-ID} . | |
DELETE | Delete the API Key access list entry for {API-KEY-ID}
specified by {IP-ADDRESS} . |
Organization API Keys on Projects Endpoints¶
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.
Method | Endpoint | Description |
---|---|---|
GET | Get All Organization API Keys Assigned to One Project with ID
{GROUP_ID} . | |
PATCH | Modify Roles of One Organization API Key to One Project. | |
POST | Create and Assign One Organization API Key to One Project. | |
PATCH | Assign One Organization API Key to One Project. | |
DELETE | Unassign One Organization API Key ( {API-KEY-ID} ) from One
Project. |