Root

System health.

get

Returns status checks for system database, configuration and registry.

My Account

Retrieves information and modifies data for your account.

get

Returns details about your account.

put

Updates your account information (not yet implemented).

delete

Deactivates your account (not yet implemented).

post

Marks an application as recently viewed. UUIDs and timestamps of recent applications are present in the "account" endpoint.

post

Stars an application. UUIDs of starred applications are present in the "account" endpoint.

post

Removes an application from the user's starred list. UUIDs of starred applications are present in the "account" endpoint.

get

Returns whether your account has access to a specific application permission.

get

Returns whether your account is an administrator for an application.

get

Returns whether your account is the owner for an application.

get

Returns the drush aliases as a compressed archive download.

get

Gets a list of all organization admin and team invites that are pending for the current user.

get

Returns a list of messages associated with the current user.

get

Returns whether your account is an administrator for an organization.

get

Returns whether your account is the owner for an organization.

post

Verifies that the supplied password matches the current user's password.

get

Gets a list of SSH keys associated with the current user.

post

Installs a new SSH key for the current user.

get

Get an SSH key associated with the currently-logged in user.

delete

Deletes an SSH key.

get

Returns whether your account is an administrator for a subscription.

get

Returns whether your account is the owner for a subscription.

get

Returns whether your account has access to a specific team permission.

get

Returns whether your account is an administrator for a team.

get

Returns whether your account is the owner for a team.

get

Returns a list of metadata for API access tokens tied to your account.

post

Creates an API access token tied to your account.

get

Return details about a specific token.

delete

Revokes an access token. This action will prevent the access token from being able to authorize access to the API in the future.

Agreements

Work with legal agreements. An agreement may be accepted or declined by any user who is invited to do so.

get

Returns a list of agreements you have been invited to accept or decline.

get

Returns a specific agreement.

put

Modify a agreement.

delete

Delete a agreement.

post

Accepts a legal agreement.

post

Declines a legal agreement.

get

Returns a list of users invited to action this agreement.

Applications

Work with applications. A subscription may contain 1 or more applications. An application contains the code, files, and databases required to run your site.

get

Returns a list of applications you have access to. You have access to an application if you are a member of a team that has access to an application, or if you are an administrator or owner of the organization that the application belongs to. Results can be filtered and sorted by name.

get

Return details about a specific application.

put

Modifies an application.

delete

Deletes an application (not yet implemented).

get

Returns a list of this application's build artifacts. Only available for Node.js applications.

get

Returns a single build artifact.

get

Returns a list of branches and tags in this application's version control system.

get

Returns a list of teams associated with this application.

get

Returns a list of environments within this application.

post

Add a new CD environment.

get

Returns a list of feature flags for this application.

get

Returns a list of messages associated with this application.

get

Returns a list of permissions the user has for this application.

get

Returns a list of tasks associated with this application. A task represents an item of work to be done, initiated by someone (typically the current user) associated with the application.

get

Returns a list of events associated with this application. An event is something that has occurred, or is currently in progress.

get

Returns a single notification. This could be either an event or a task.

get

Returns a list database names for the application.

post

Creates a database. This action will create a new database within each environment of the application.

delete

Deletes a database. This action will remove the database from all environments within this application.

post

Erases (truncates) a database. This action will erase the database in ALL environments within this application.

get

Returns insight data for all sites associated with the application.

get

Does not return any data. Allows traversal to settings groups endpoints.

get

Returns the hosting settings for this application.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns the legacy product keys for this application.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns the remote administration settings for this application.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

put

Modifies the remote administration settings for an application.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns the security policy settings for this application.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

put

Modifies the security policy settings for an application.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns whether a desired application machine name is available. If it is not available, an available name is suggested.

Drupal Distributions

Work with available Drupal distributions.

get

Returns a list of Drupal distributions that are available for installation in an Acquia Cloud environment.

get

Return details about a specific distribution.

Environments

Work with an application's environments. Each application has one or more environments associated with it.

get

Return details about a specific environment.

put

Modifies configuration settings for an environment. Note that some settings cannot be configured for certain subscriptions.

delete

Deletes a CD environment.

post

Change the label for an environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

post

Resize an environment.

post

Deploys an artifact to this environment.

get

Returns the available runtimes for an application.

get

Returns insight data for all sites associated with the environment.

Enables production mode for an environment. While production mode is enabled, files and databases cannot be copied to the production environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

post

Removes protection from a production environment, taking it out of production mode.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

post
get

Returns a list of domains.

post

Adds a domain to the environment.

post

Clears the Varnish cache for one or more domains attached to this environment.

get

Return details about a specific domain.

delete

Removes the domain from this environment.

get

Retrieves the scan data for a domain name that is part of this environment.

get

Returns details about the domain.

post

Clears the Varnish cache for this domain.

post

Enable Live Development on this environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

post

Disable Live Development on this environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns a list of log files for this environment available for download.

get

Downloads the log file.

post

Creates a log file snapshot.

get

Returns a logstream url and metadata.

get

Does not return any data. Allows traversal to metrics groups endpoints.

get

Does not return any data. Allows traversal to Stackmetrics endpoints.

get

Returns details about a specific Stackmetrics set.

get

Returns details about a specific Stackmetrics metric.

get

Returns a list of environment variable associated with this environment.

post

Adds a new environment variable to an environment.

get

Get an environment variable associated with this environment.

delete

Removes an environment variable from an environment.

put

Updates an environment variable on an environment.

get

Returns a list of servers.

get

Return details about a specific server.

put

Modifies configuration settings for a server.

post

Reboots a server. This will cause all applications on this server to be unavailable while the server reboots.

post

Relaunches a server. This will cause all applications on this server to be unavailable while the server relaunches.

post

Resizes a server. All applications on this server will be unavailable while the server is resized. The total time to resize a server depends on the size and usage of storage space.

post

Suspends a server. The server will no longer respond to web requests.

post

Upgrades a server from \"precise\" to \"xenial\".

get

Provides links to environment settings.

get

Return details about a specific apm.

put

Update configuration for an APM tool.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns a list of databases.

post

Copies a database to this environment.

get

Return details about a specific databasis.

get

Returns PHP configuration details for this database.

get

Returns a list of backups.

post

Create a backup.

get

Return details about a specific database-backup.

delete

Deletes a database backup.

get

Downloads the database backup file.

post

Restores this backup to the appropriate environment's database.

post

Copies files to this environment.

post

Deploys code to this environment.

post

Switches code on this environment to a different branch or tag.

post

Imports a site to this environment.

post

Install a Drupal site to this environment from a Drush makefile.

get

Returns a list of crons.

post

Creates a scheduled job with cron.

get

Return details about a specific cron.

put

Modify an existing scheduled job.

delete

Delete a cron.

post

Enable a previously disabled cron.

post

Disable a cron.

Returns the SSL settings for this environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

get

Returns the SSL settings for this environment.

get

Returns the SSL certificates that are installed on this environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.

post

Install a new SSL certificate on this environment.

Deprecated: This endpoint is expected to be replaced with similar functionality at a later time.