Information for: DEVELOPERS   PARTNERS

Cloud Platform API v1 authentication

Cloud Platform API version 1 (v1) will reach end-of-life on July 1, 2020. Acquia recommends upgrading your API calls to use Cloud Platform API v2 authentication to avoid any interruption of service.

All Cloud Platform API calls (whether in a RESTful API call or in a Drush Cloud command) need to be authenticated in order to work. You authenticate a call using your user name (the email address with which you sign in to Acquia) and a private key you can find on your Acquia Profile page.

Cloud Platform API private keys and API tokens

Cloud Platform also uses a method of API authentication using API tokens. In this release, API tokens are used only to authenticate with the pipelines feature. For all other Cloud Platform API purposes, authenticate with the Cloud Platform API using the Cloud Platform API private key described on this page.

To find your private key:

  1. Sign in to Cloud Platform using your email address and Acquia password.

  2. Click your user avatar in the top right corner, and then click the Account Settings button to open your Acquia profile.

    Account Settings button

  3. On the Profile page, click Credentials, and then enter your Acquia password.

    Profile Credentials page

  4. Under Cloud API, click Show, and then copy your private key.

You can change your Cloud Platform API private key at any time by clicking Regenerate private key.

Authenticating in Cloud Platform API RESTful interface calls

Each Cloud Platform API call has a required username and password argument, in the format user:password. Use the email address in your Acquia profile for the username, and the Cloud Platform API private key in your Acquia profile for the password.

Authenticating in Drush Cloud commands

To use Drush Cloud commands, download the Cloud Platform Drush integration, as described in Using Drush aliases. Your Cloud Platform API credentials are included in the download, in the .acquia/cloudapi.conf file.

Authenticating from a browser

Cloud Platform API also implements Cross-origin resource sharing (CORS), enabling you to implement authentication in browser-based clients when using Acquia’s supported API tokens. Requests should use the Access-Control-Allow-Origin header for identification.

API rate limits in Cloud Platform API v1

To prevent a single user from adversely affecting shared resources, there is a rate limit for Cloud Platform API calls. The rate limit varies by Cloud Platform subscription level and is measured by authenticated calls per hour per Cloud Platform API user (defined by the private key used with the call).

Subscription level Rate limit
Cloud Platform Enterprise 1000
Cloud Platform Professional 360
Cloud Platform Free 10

Realm requirements in Cloud Platform API v1

The realm (required for Cloud Platform API v1 calls) is the Cloud Platform location in which the environment is running. The realm corresponds to the element before in an environment’s server name, and is one of the following values, based on your subscription level:

Subscription level Realm
Cloud Platform Enterprise prod
Cloud Platform Professional devcloud