Information for: DEVELOPERS   PARTNERS

Developing with the Cloud API

Acquia Cloud has an additional interface developers can use to extend, enhance, and customize Acquia Cloud: the Acquia Cloud API.

The Acquia Cloud API is a RESTful web interface that allows developers to extend, enhance, and customize Acquia Cloud. It includes developer workflow, website management, and provisioning capabilities.

What can the Acquia Cloud API do?

You can use the Acquia Cloud API to do many of the tasks that are needed as part of your daily application development and continuous integration process.

  • Workflow – Deploy code, databases, and user-uploaded files across your Development, Staging, and Production environments. The Acquia Cloud API enables you to run any branch or tag from your Git repository in any environment as you can do from the Acquia Cloud interface. This allows you to automate these functions, instead of having to log in to the Acquia Cloud interface and manually drag elements from one environment to another.
  • Backups – Create, restore, and delete backups of your application’s databases. Acquia Cloud fully supports Drupal multisite installations, with as many databases per codebase as you need.
  • Information – Retrieve current information about your application and its environments, including deployed code, databases, backups, and tasks.
  • User Roles and Permissions – The Acquia Cloud API allows you to work with roles and permissions as you would do from the Acquia Cloud interface. You can create and remove teams, add or remove members from teams, or modify which applications are associated to which teams. Automate any functions you perform on a regular basis.

Even better, the real magic behind the Cloud API is its integration with Cloud Hooks, which allows you automate nearly any action to be performed along with your workflow actions. You can do the following:

  • Perform Drupal database updates or run your test suite when new code is deployed, and roll back to a previous release if the tests fail.
  • Scrub your Production database when it is copied to Development or Staging by removing customer emails or disabling production-only modules.
  • Integrate with third-party services, for example, by performing a Blitz.io performance test, when you deploy new code.

Getting Started

To get started with the Acquia Cloud API, generate your API token as described in Cloud API v2 authentication.

For information about getting started with Acquia Cloud API v1, see Cloud API v1 authentication.

Permissions for accessing the Acquia Cloud API

The roles and permissions assigned to your Acquia Cloud account determine the portions of Acquia Cloud API v2 you can access. Unlike Acquia Cloud API v1, no additional Access the Cloud API permission is required. For information on assigning permissions to users in your organization, see Working with roles and permissions.

Permissions for Acquia Cloud API v1

To use Acquia Cloud API v1, a user must have the Access the Cloud API permission. By default, all users with the Team Lead, Senior Developer, and Administrator roles have the Access the Cloud API permission, while users with only the Developer role do not. Administrators can modify the permissions of existing roles, or add new custom roles with the desired permissions. For more information, see Editing a role.

Users who have the Access the Cloud API permission can use Acquia Cloud API v1 to take most of the actions enabled by the Acquia Cloud interface, and are not constrained by any other permissions in their use of the Acquia Cloud API.

Additional resources