Important
If you are using the deprecated Cloud Platform API v1, see Cloud API v1 EOL: Am I using it and what do I need to do?.
To enable you to extend, enhance, and customize Cloud Platform for your organization’s needs, Cloud Platform includes the Cloud Platform API, a RESTful web interface for these types of changes.
The Cloud Platform API v2 (API documentation) includes over 200 endpoints to enhance developer workflow, website management, and provisioning capabilities, such as:
To get started with your use of the Cloud Platform API, select the version of the API you will be using:
You can use the Cloud Platform API to do many of the tasks that are needed as part of your daily application development and continuous integration process.
Notable to the Cloud Platform 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:
With more robust documentation and monitoring, the Cloud Platform API v2 provides additional functionality as compared to Cloud Platform API v1, as described in the following table:
Category | Cloud Platform API v2 |
---|---|
Development focus | Manage deployments, plus any other task available in the Cloud Platform user interface |
Documentation | Cloud Platform API v2 |
Framework | OpenAPI |
Authentication method | Uses a key/secret pair to generate OAuth tokens |
How to call an endpoint | Build your own tooling, or use open source tooling to get started, such as Acquia CLI (recommended), the Typhonius PHP SDK or Typhonius CLI. |
The roles and permissions assigned to your Cloud Platform account determine how you interact with the Cloud Platform API, by version.
Unlike Cloud Platform API v1, you are not required to have the Access the Cloud API permission to use the Cloud Platform API.
For information about assigning permissions to users in your organization, see Working with roles and permissions.
To prevent a single user from adversely affecting shared resources,
Cloud Platform API calls are limited to 100 calls per minute.
Cloud Platform API calls exceeding the rate limit receive an
HTTP 429 Too Many Requests
status code response containing a
Retry-After
header, containing the number of seconds until
Cloud Platform API calls will be unblocked.
authentication script
database creation script