Acquia Environments API
The Environments API from Acquia — 73 operation(s) for environments.
OpenAPI Specification
openapi: 3.0.0
info:
contact:
name: Customer Experience Engineering (CXE)
url: https://www.acquia.com
description: "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one week notice\n * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one month notice\n * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n application/hal+json\n {\n \"error\": \"system\",\n \"message\": \"This action is currently unavailable. Please try again later.\"\n }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: <a href='https://docs.acquia.com/acquia-cloud/develop/api/auth/' target='_blank'>https://docs.acquia.com/acquia-cloud/develop/api/auth/</a>\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found <a href='https://docs.acquia.com/resources/useful-references' target='_blank'>here</a>. This script uses the <a href='https://oauth2-client.thephpleague.com/' target='_blank'>League/oauth2-client</a> library, installed via Composer.\n"
title: Acquia Cloud API Account Environments API
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
servers: []
tags:
- name: Environments
paths:
/environments/{environmentId}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
delete:
description: Deletes a CD environment.
operationId: deleteEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69
self:
href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1
message: The environment is being deleted.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: Accepted
'403':
content:
application/hal+json:
examples:
Cannot delete CD environments on non-hosted applications:
value:
error: forbidden
message: CD environments cannot be deleted on non-hosted applications.
Cannot delete environments for managed applications:
value:
error: forbidden
message: Environments cannot be deleted for Service Management-enabled applications.
Cannot delete environments on Node.js applications:
value:
error: forbidden
message: Environments cannot be deleted on Node.js applications.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to delete this environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
Environment Not found:
value:
error: not_found
message: The environment you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Deletes a CD Environment.
tags:
- Environments
x-cli-name: environments:delete
get:
description: 'Return details about a specific environment.
To find your environment ID via API:
1. Make a request to GET `/api/applications/[uuid]/environments`.
2. Find the entry that matches your environment. If you don''t know the application UUID, first make a request to GET `/api/applications`.
To find your environment ID via cloud.acquia.com:
1. Open [https://cloud.acquia.com](https://cloud.acquia.com).
2. Navigate to your application.
3. Navigate to the environment.
4. See the environment ID in the browser URL.
For example, in this URL `https://cloud.acquia.com/app/develop/applications/53785bca-1946-4adc-a022-e50d24686c20/environments/289576-53785bca-1946-4adc-a022-e50d24686c20`, the environment id is `289576-53785bca-1946-4adc-a022-e50d24686c20`.
'
operationId: getEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
application:
_links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
name: Sample application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
_links:
available-runtimes:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/available-runtimes
cdn:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn
cloud-actions:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cloud-actions
crons:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons
databases:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
dns:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/dns
domains:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains
eips:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips
logs:
href: https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/logs
metrics:
href: https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics
parent:
href: https://cloud.acquia.com/api/environments
search:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/search
self:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
servers:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers
ssl:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/ssl
variables:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/variables
active_domain: example.com
application:
name: Sample application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact: null
balancer: balancers
configuration:
operating_system: precise
php:
apcu: 64
client_max_body_size: 128
interned_strings_buffer: 16
max_execution_time: 300
max_input_vars: 1000
max_post_size: 256
memcached_limit: 64
memory_limit: 128
opcache: 96
upload_max_filesize: 128
version: '8.3'
default_domain: sitedev.hosted.acquia-sites.com
domains:
- sitedev.hosted.acquia-sites.com
- example.com
flags:
cde: false
cdn: false
cloud-actions: false
eips: false
email: false
hsd: false
livedev: false
multi_region: false
multicert: false
production: false
production_mode: false
remote_admin: false
varnish: true
varnish_over_ssl: false
gardener:
multi-site: example.com/admin/gardens/staging
site-update: example.com/admin/gardens/site-update
id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
image_url: null
ips:
- 10.0.1.5
label: Dev
name: dev
platform: cloud
region: us-east-1
size: medium
ssh_url: site.dev@sitedev.ssh.hosted.acquia-sites.com
status: normal
type: drupal
vcs:
path: master
type: git
url: site@svn-3.hosted.acquia-sites.com:site.git
weight: 0
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The environment you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Details About a Specific Environment.
tags:
- Environments
x-cli-name: environments:find
options:
description: Displays environment options.
operationId: optionsEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- default: 32
maximum: 512
minimum: 32
name: apcu
step: 1
- default: 8
maximum: 32
minimum: 8
name: interned_strings_buffer
step: 1
- default: 256
maximum: 1024
minimum: 0
name: client_max_body_size
step: 1
- default: 300
maximum: 300
minimum: 1
name: max_execution_time
step: 1
- default: 1000
maximum: 20000
minimum: 500
name: max_input_vars
step: 1
- default: 256
maximum: 1024
minimum: 64
name: max_post_size
step: 1
- default: 256
maximum: 1024
minimum: 0
name: upload_max_filesize
step: 1
- default: 128
maximum: 1024
minimum: 128
name: memory_limit
step: 1
- default: 64
maximum: 12288
minimum: 0
name: memcached_limit
step: 64
- default: 96
maximum: 512
minimum: 96
name: opcache
step: 1
- default: null
maximum: null
minimum: null
name: operating_system
step: null
- default: null
maximum: null
minimum: null
name: version
step: null
_links:
filter:
href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93{?filter}
templated: true
parent:
href: https://cloud.acquia.com/api/environments
self:
href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93
sort:
href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93{?sort}
templated: true
total: 10
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-options'
description: OK
'404':
content:
application/hal+json:
examples:
No environment or permission:
value:
error: not_found
message: The environment you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Displays Environment Options.
tags:
- Environments
put:
description: Modifies configuration settings for an environment. Note that some settings cannot be configured for certain subscriptions.
operationId: putEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
requestBody:
content:
application/hal+json:
example:
apcu: 32
client_max_body_size: 192
max_execution_time: 10
max_input_vars: 1000
max_post_size: 256
memcached_limit: 128
memory_limit: 192
operating_system: focal
upload_max_filesize: 192
version: '8.3'
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
application/x-www-form-urlencoded:
example:
apcu: 32
client_max_body_size: 192
max_execution_time: 10
max_input_vars: 1000
max_post_size: 256
memcached_limit: 128
memory_limit: 192
operating_system: focal
upload_max_filesize: 192
version: '8.3'
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5
self:
href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93
message: The environment configuration is being updated.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
No changes requested:
value:
error: forbidden
message:
system: No environment configuration changes are specified.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Cannot delete CD environments on non-hosted applications:
value:
error: forbidden
message: CD environments cannot be deleted on non-hosted applications.
Cannot delete environments on Node.js applications:
value:
error: forbidden
message: Environments cannot be deleted on Node.js applications.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to delete this environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not available for static applications:
value:
error: not_available
message: Environment configuration cannot be modified for static applications.
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Conflict:
value:
error: conflict
message: operating_system cannot be configured on this environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Modifies Configuration Settings for an Environment.
tags:
- Environments
x-cli-name: environments:update
/environments/{environmentId}/actions/change-label:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
deprecated: true
description: Change the label for an environment.
operationId: postChangeEnvironmentLabel
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
requestBody:
content:
application/hal+json:
example:
label: New Label
schema:
properties:
label:
description: The new environment label.
type: string
required:
- label
type: object
application/x-www-form-urlencoded:
example:
label: New Label
schema:
properties:
label:
description: The new environment label.
type: string
required:
- label
type: object
required: true
responses:
'202':
content:
application/hal+json:
examples:
Changing label:
value:
message: Changing environment label.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: Accepted
'400':
content:
application/hal+json:
examples:
Label already used:
value:
error: validation_failed
message:
label: Another environment within this application already has this label.
Missing parameter:
value:
error: validation_failed
message:
name: 'Missing required parameter(s): example_param'
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to change the label for this environment.
Labels can only be changed on hosted applications:
value:
error: forbidden
message: Environment labels cannot be changed on non-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Bad Request
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The environment you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Change the Label for an Environment.
tags:
- Environments
x-cli-name: environments:label-update
/environments/{environmentId}/actions/clear-caches:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Clear caches for Varnish and Platform CDN (if Platform CDN is enabled).
operationId: postEnvironmentsClearCaches
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
requestBody:
content:
application/hal+json:
example:
domains:
- domain1.example.com
- domain2.example.com
schema:
properties:
domains:
description: A list of domains to clear the caches for.
items:
format: hostname
type: string
type: array
required:
- domains
required: true
responses:
'202':
content:
application/hal+json:
examples:
Clearing cache:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
self:
href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/actions/clear-caches
message: Caches are being cleared.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'403':
content:
application/hal+json:
examples:
Can only be cleared on hosting applications:
value:
error: forbidden
message: Caches cannot be cleared on non-hosted applications.
Cannot be cleared for Node.js applications:
value:
error: forbidden
message: Caches cannot be cleared on Node.js applications.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to clear caches on this environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The environment you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Clears the Caches for One or More Domains Attached to This Environment.
tags:
- Environments
x-cli-name: environments:clear-caches
/environments/{environmentId}/artifacts/actions/switch:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Deploys an artifact to this environment.
operationId: postDeployArtifact
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
requestBody:
content:
application/hal+json:
example:
artifact_id: '123'
schema:
properties:
artifact_id:
description: The id of the artifact to deploy.
type: string
required:
- artifact_id
type: object
application/x-www-form-urlencoded:
example:
artifact_id: '123'
schema:
properties:
artifact_id:
description: The id of the artifact to deploy.
type: string
required:
- artifact_id
type: object
required: true
responses:
'202':
content:
application/hal+json:
examples:
Deploying artifact:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5
self:
href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/artifacts/actions/switch
message: Deploying artifact.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Only ready artifacts can be deployed:
value:
error: validation_failed
message:
artifact_id: Only artifacts that are in the 'ready' state can be deployed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Forbidden
'403':
content:
application/hal+json:
examples:
Cannot be deployed on Node.js applications:
value:
error: forbidden
message: Artifacts can only be deployed on Node.js applications.
Cannot be deployed on managed applications:
value:
error: forbidden
message: Artifacts cannot be deployed on Service Management-enabled applications.
Cannot be deployed on non-hosted applications:
value:
error: forbidden
message: Artifacts cannot be deployed on non-hosted applications.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to deploy an artifact to this environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Bad Request
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The environment you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Not found:
value:
error: conflict
message: The artifact with ID 123 does not belong to this application and cannot be deployed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Deploys an Artifact to This Environment.
tags:
- Environments
x-cli-name: environments:artifact-deploy
/environments/{environmentId}/available-runtimes:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of available runtimes.
operationId: getAvailableRuntimes
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
responses:
'200':
content:
application/hal+json:
# --- truncated at 32 KB (456 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-environments-api-openapi.yml