Information for: DEVELOPERS   PARTNERS

Cloud API authentication

All Cloud 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 that you can find on your Acquia Profile page.

Cloud API private keys and API tokens

Acquia Cloud 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 API purposes, authenticate with the Cloud API using the Cloud API private key described on this page.

To find your private key:

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

  2. Click your user avatar in the upper right corner, and then click Edit profile.

    Edit your profile

  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 API private key at any time by clicking Regenerate private key.

Authenticating in Cloud API RESTful interface calls

Each Cloud 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 API private key in your Acquia profile for the password.

Authenticating in Drush Cloud commands

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

Authenticating from a browser

Acquia Cloud 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.