Cloud Platform API Overview

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

An overview of the Acquia Cloud API can be found at:

• https://docs.acquia.com/cloud-platform/develop/api

The current version that is in place is Version 2. Reference documentation can be found at https://cloudapi-docs.acquia.com/.

To access you need to use the OAuth 2.0 client credentials method which will provide an Access token to allow permission to access the API. Be aware that the URL to use to authenticate is https://accounts.acquia.com/api/auth/oauth/token as detailed at https://docs.acquia.com/cloud-platform/develop/api/auth/#authenticating-in-cloud-api-restful-interface-calls.

To generate the Acquia API Token follow the instructions at https://docs.acquia.com/cloud-platform/develop/api/auth/#authenticating-in-cloud-api-restful-interface-calls. Ensure that you save the API Key and API secret in your favorite password manager. With the API Key and API secret you can then obtain an Access Token for accessing the API.

Postman

We recommend that you use the Postman application to help craft correct API paths and manage token authentication and explore the API further. You can download it from https://www.postman.com/.

Instructions for using Postman with Acquia: https://docs.acquia.com/resource/postman/

Once you have a Cloud Platform API Token you can then use your credentials to obtaining an Access Token: https://docs.acquia.com/resource/postman/#configure-authorization-in-postman

Important Note

The access token will expire 300 seconds (or 5 minutes) after you generate it and must be regenerated before then.

To use the API refer to the Acquia Cloud API Documentation.

An example of ensuring that you are retrieving API details is to use the GET /applications endpoint in Postman.

With your Authorization use the GET to URL https://cloud.acquia.com/api/applications

A cURL Example:

Using the API Key and API secret that is generated here: https://docs.acquia.com/cloud-platform/develop/api/auth/#cloud-generate-api-token

curl https://accounts.acquia.com/api/auth/oauth/token --data-urlencode "client_id=api_key" --data-urlencode "client_secret=api_secret" --data-urlencode "grant_type=client_credentials"

Then use the access_token to request a GET /application with the "Authorization: Bearer" header:

curl --location --request GET 'https://cloud.acquia.com/api/applications' --header 'Authorization: Bearer access_token'

An example:

curl --location --request GET 'https://cloud.acquia.com/api/applications' --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpZCI6ImZiZTAzMGRiMTkxOGQ2NGVlNjZmNjNmYjlkYjY4MTU4YzhmNmNiZWUiLCJqdGkiOiJmYmUwMzBkYjE5MThkNjRlZTY2ZjYzZmI5ZGI2ODE1OGM4ZjZjYmVlIiwiaXNzIjoiM2FkNTk2YmEtNjY0ZC00YTkxLTg1NDEtZDYwY2Y2NWI2OTY4IiwiYXVkIjoiNjk2OTk4Y2UtYzAyOC00NjYyLTk3NzYtMjhmYzZmMGE5ZDY1Iiwic3ViIjoiYzBkNzNiYzctNjYwMS1mZmI0LWYxZGUtZThmNTc1YTIyNTZkIiwiZXhwIjoxNTk4OTcyMDczLCJpYXQiOjE1OTg5NzE3NzMsInRva2VuX3R5cGUiOiJiZWFyZXIiLCJzY29wZSI6Im9yZ2FuaXphdGlvbjo1ZGI2Yjk0Ni1lNjE0LTQxM2YtODJmZC1kYmIzNjdkZTRjMTYgb3JnYW5pemF0aW9uOmM2MDI2ZTRlLWIxMDEtMTFlMy05MTcwLTEyMzEzOTIwYTAyYyJ9.JsrJ5UrY7lj5u6RCjRagF-q1ypOds3cvkJQCnXsK8B8QQksjSvXfs53_zz3KPdJN-xLxJPXo3jddhyujkl8s6mcUUSSbwaFWmMmDynclQVNm2U0Uxx6zkynGXmOZTWlD-exSFwvTcdBlby6BImGrAiBUsiWUB5TWWvH3-uV9Cbo5J2grdt7-I7LxeElTMBnYjJNO5Q9FweVvP6Lhg8bAReOC38YulJApGTuM9oRq6LKt7hq3MsdFUwrNreDztrXMDQwY8LDwfQvpoWKrxn8DP8rwSnc86jDcoYWPfI8sqpPtiEdvh4V3Qdyxr4bJwmFxmn6B1G2y7l5NScw2BFQqucmfsK0gGUebyEEoiewJiY02fDXl2Ubjoo3GnlT4sLqOEcIKm0I3tlUnzH6fe1QUYWi7MztmZ9zNSZo4UHGc20Bz6dsjafjafdjj-dajlriavOP'