Version 1 Deprecation

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

Acquia has provided some reources for migration to API v2.

Version 1 Information

The Acquia Cloud API allows developers to extend, enhance, and customize Acquia Cloud. There are three major components to Cloud API:

A RESTful web interface that allows direct control of Acquia Cloud sites. Complete documentation for the Cloud API web interface is below.

Acquia Cloud Drush commands, which allow you to use all features of the Cloud API either on the command line or from shell scripts using the Drush command-line tool.

Cloud Hooks, which are scripts in your code repository that Acquia Cloud executes on your behalf when a triggering action, including certain Cloud API functions, occurs. Complete documentation, templates, and sample scripts for Cloud Hooks are available at https://github.com/acquia/cloud-hooks.

Cloud API is available to all Acquia Cloud customers. To learn about how to get started with it, including information about your Cloud API credentials, Drush aliases, and the Acquia Cloud, see Developing with the Cloud API.

Additional resources:

API overview

Just the facts:

Current version v1 Endpoint https://cloudapi.acquia.com/v1 Format JSON. All resource URLs must specify a “.json” suffix. Authentication HTTP Basic Auth over SSL. Credentials Available on the Credentials page of your Acquia Profile. Status codes Standard. Rate limit Varies by Acquia Cloud subscription type.

API functions are listed below, first summarized by category, then followed with complete documentation including arguments, return values, and an example call. In each of the examples, 'user' represents your email address that's registered in your Acquia Profile, while 'pass' represents your Cloud API key, found on the Credentials page of your Acquia Profile.