Create One API Key for One Project¶
On this page
Note
Required Permission
To make this API request, you must have the
Project Owner role.
Note
Requires Access List
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.
1
Navigate to the Access Manager page for your project.¶
- If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
- Select your desired project from the list of projects in the Projects page.
- Click the vertical ellipsis () next to your project name in the upper left corner and select Project Settings.
- Click Access Manager in the navigation bar, then click your project.
2
Click Create API Key.¶
3
Enter the API Key Information.¶
On the Create API Key page:
- Enter a Description.
- In the Project Permissions menu, select the new role or roles for the API key.
4
Click Next.¶
5
Copy and save the Public Key.¶
The public key acts as the username when making API requests.
6
Copy and save the Private Key.¶
The private key acts as the password when making API requests.
Warning
Save Private Key
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.
7
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 will also make API requests using this API Key.
- Click Save.
8