The x-acquia-exposure directive includes an audience field that controls which consumers can discover and invoke the endpoint. Supported values are:
public: Exposed to external consumers and integrators.
Custom Scopes: Extensible values such as partner or fedramp.
Deprecated operations in API v3 are marked using the standard OpenAPI deprecated: true flag in the API specification. Acquia CLI (ACLI) surfaces runtime warnings when a caller invokes a deprecated operation. Developers should monitor these warnings and migrate to replacement endpoints as they become available.
All resource endpoints are versioned in the API. Endpoints that reach production stability do not introduce breaking changes within the major API version, whereas non-production endpoints do not provide versioning guarantees for changes. API v3 is a separate API line from API v2 and the two coexist independently.
The channels block within the x-acquia-exposure directive defines the communication mediums where the operation is available.
rest.enabled: The operation is accessible through standard HTTP REST requests.cli.enabled: The operation is accessible through Acquia CLI (ACLI).cli.command: A string that maps the endpoint to its corresponding ACLI command name (for example, sites:list).Rate limiting for API v3 is enforced at the API Gateway level on a per-service basis. If a caller exceeds the configured threshold, the API Gateway rejects the request with a 429 Too Many Requests status code. Callers must implement exponential backoff and respect the Retry-After response header.
All API v3 operations require authentication through Acquia ID using OAuth2 protocols. Service specifications must integrate standard security schemes defined in the canonical OpenAPI 3.1 specification. To learn more about setup and credentials, refer to Acquia Cloud API Authentication.
In addition to standard error codes, some endpoints return a 503 Service Unavailable status code when dependent services are unavailable, returning the following JSON payload:
application/hal+json
{
"error": "system",
"message": "This action is currently unavailable. Please try again later."
}If this content did not answer your questions, try searching or contacting our support team for further assistance.
If this content did not answer your questions, try searching or contacting our support team for further assistance.