You were redirected from a different version of the documentation. Click here to go back.
  • API >
  • Configure API Access

Configure API Access

To access the Cloud Manager API using applications, generate an API key for your organization.

API Keys can’t use the Cloud Manager Console

Organization-based API Keys aren’t associated with user credentials. You can’t use these API Keys to log in to the Cloud Manager console.


(Optional) Require an API Access List for Your Organization

Cloud Manager allows your Cloud Manager Administration API keys to make requests from any address on the internet unless you require an IP access list for the Cloud Manager Administration API. If you require an IP access list, your API keys can make API requests only from the location-based IP or CIDR addresses that you specify in the IP access list.

Each API key has its own IP access list. If you require an IP access list for all Cloud Manager Administration API requests, you must define at least one IP access list entry for an API key before you can use the API key.

When you create a new organization using the Cloud Manager UI, Cloud Manager enables the API access list requirement by default. To disable the IP access list requirement when you create an organization, toggle Require IP Access List for Cloud Manager Administration API to OFF when you create an organization.

To set your organization to require IP access lists for every Cloud Manager Administration API key after organization creation, follow these steps:

  1. Log into Cloud Manager.
  2. Access the Organization using the Context picker in the top-left hand corner of the Cloud Manager UI.
  3. Click Settings from the left hand navigation.
  4. Toggle the Require IP Access List for Cloud Manager Administration API setting to On.

Manage Access to the API

You can set API Keys for an entire organization or project.