Configure Atlas API Access¶
On this page
To access the Atlas API, generate an API key for your organization.
Organization API keys aren't associated with user credentials and can't log in to the Atlas console.
You can limit the locations from which API requests can be made.
Organization API Keys¶
Organization API keys have two parts: a Public Key and a Private Key. You can't use an API key to log into Atlas through its console.
All API keys belong to the organization. You can give an API key access to a project.
- To create and manage API keys, use the Access Manager.
- To add the new API key created in an organization, invite the API key to the project.
Manage Organization API Keys¶
To perform any of the following actions, you must have the
Organization Owner role.
Manage API Key Access to a Project¶
To perform any of the following actions, you must have the
Project Owner role.
API Resource Request Access Lists¶
Atlas allows your API key to make requests from any address on the internet. Atlas has some exceptions to this rule. These exceptions limit which resources an API key can use without location-based limits.
To add these location-based limits to your API key, create an API Access List. This list limits the internet addresses from which a specific API key to make API requests.
Any API keys with an API access list require all API requests to come from an IP address on that list. Your API access list must include entries for all clients that use the API.
Use API Resources that Require an Access List¶
The following API resources require an API access list:
Organization API Access List Entries¶
Cloud Backup Restores¶
- Return a dedicated or serverless cloud backup restore job.
- Return all dedicated or serverless cloud backup restore jobs.
- Restore a dedicated or serverless cloud backup snapshot.
- Cancel the restore of a dedicated or serverless cloud backup snapshot.
Cloud Backup Snapshots¶
Legacy Backups¶
- Restore, remove, or change the expiration date of a legacy backup snapshot.
- Clear or update a legacy backup snapshot schedule.
Require an API Access List for All Requests¶
You can require all API requests from an API key to come from an entry on its API access list. If you require API access lists, API keys can't make any API requests until you define at least one API access list entry.
To set your organization to require API access lists for every API key:
Log in to Atlas.¶
Navigate to the Settings page for your organization.¶
- If it is not already displayed, select your desired organization from the Organizations menu in the navigation bar.
- Click the Organization Settings icon next to the Organizations menu.