Use Acquia Cloud Platform API v3 (API v3) to programmatically manage your Acquia products. Starting with Multi-Experience Operations (MEO), API v3 centers operations around MEO’s domain entity model. Use these APIs to automate continuous integration and deployment pipelines, manage your multisite portfolios, and integrate internal infrastructure workflows.

Key Capabilities

API 3 updates the management architecture with the following capabilities:

• Codebase-centric operations: Map your operations directly to shared codebases rather than single applications.
• Granular authorization: Manage secure access control with out-of-the-box support for granular teams and permission models.
• Unified architecture: Build predictable integrations using consistent, hierarchical path structures for API routes and event subjects.
• Security compliance: Rely on an API gateway architecture that complies with PCI, ISO-SOC2, and FedRAMP security frameworks.

Authentication

All API v3 endpoints require authentication. The API uses JSON Web Token, or JWT, validation. Acquia ID authentication services handle JWT validation securely.

To authenticate programmatic workloads, you must generate API credentials, exchange the credentials for a temporary access token, and include that token in the header of every API v3 request.

Generating API Credentials

1. Sign in to the Cloud Platform user interface.
2. Click your user avatar in the upper right corner, and then click .

Use Acquia Cloud Platform API v3 (API v3) to programmatically manage your Acquia products. Starting with Multi-Experience Operations (MEO), API v3 centers operations around MEO’s domain entity model. Use these APIs to automate continuous integration and deployment pipelines, manage your multisite portfolios, and integrate internal infrastructure workflows.

Key Capabilities

API 3 updates the management architecture with the following capabilities:

• Codebase-centric operations: Map your operations directly to shared codebases rather than single applications.
• Granular authorization: Manage secure access control with out-of-the-box support for granular teams and permission models.
• Unified architecture: Build predictable integrations using consistent, hierarchical path structures for API routes and event subjects.
• Security compliance: Rely on an API gateway architecture that complies with PCI, ISO-SOC2, and FedRAMP security frameworks.

Authentication

All API v3 endpoints require authentication. The API uses JSON Web Token, or JWT, validation. Acquia ID authentication services handle JWT validation securely.

To authenticate programmatic workloads, you must generate API credentials, exchange the credentials for a temporary access token, and include that token in the header of every API v3 request.

Generating API Credentials

1. Sign in to the Cloud Platform user interface.
2. Click your user avatar in the upper right corner, and then click Account Settings.
3. On the Profile page, click API Tokens.

4. Provide a human-readable label for your API token, and click Create Token.

   Cloud Platform displays an API Key and API secret.

5. Record a copy of your API Key and API secret. For security reasons, you cannot view the secret again after you close the window.

Using the Access Token

To authenticate API v3 requests, you must include the access_token string in the HTTP headers as a Bearer token.

Example Header:Generating an Access Token

After you obtain the credentials, you must exchange the credentials for an access token. Use the standard OAuth 2.0 client credentials flow to exchange the credentials.

Make an HTTP POST request to Acquia token endpoint. You must format the request body as application/x-www-form-urlencoded and pass the API Key and API secret.

Example cURL Request:

curl -X POST "https://accounts.acquia.com/api/auth/oauth/token" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

If the credentials are valid, the endpoint returns a JSON response that contains the temporary access token:

{
  "access_token": "accesstoken",
  "token_type": "Bearer",
  "expires_in": 300
}
Authorization: Bearer <your_access_token>

Token Expiration

For security purposes, the access token expires exactly 300 seconds after Acquia ID generates the token.

Do not generate a new token for every individual API v3 call. Reuse the valid token until the token expires.

After the token expires, API requests fail with a 401 Unauthorized error. You must repeat the POST request to generate a fresh token before you make further API calls.

For more information, refer to Acquia Cloud Platform API (3.0.0).