Create One API Key in One Organization¶
On this page
Organization API keys have two parts: a Public Key and a Private Key. You need both to access the Atlas Administration API. You can't use an API key to log into Atlas through its console.
When you create a new API key, Atlas grants key the following permissions:
Organization | |
|---|---|
Project |
You can add more permissions to the new API key when you create it.
To make this API request, you must have the
Organization Owner role.
To make this API request:
- Configure an IP access list.
- Add the IP addresses or CIDR blocks of your client applications to the access list using the console or API. If you host your application on AWS, you can use an AWS security group ID as well.
Changing an API key's access list might impact multiple organizations, projects, or both.
Navigate to the Access Manager page for your organization.¶
- If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
- Click Access Manager in the sidebar, or click Access Manager in the navigation bar, then click your organization.
Click Create API Key.¶
Enter the API Key Information.¶
- Enter a Description.
- In the Organization Permissions menu, select the new role or roles for the API key.
Click Next.¶
Copy and save the Public Key.¶
The public key acts as the username when making API requests.
Copy and save the Private Key.¶
The private key acts as the password when making API requests.
The Private Key is only shown once: on this page. Click the Copy button to add the Private Key to the clipboard. Save and secure both the Public and Private Keys.
Add an API Access List Entry.¶
- Click Add Access list Entry.
Enter an IP address from which you want Atlas to accept API requests for this API Key.
You can also click Use Current IP Address if the host you are using to access Atlas also will make API requests using this API Key.
- Click Save.