Acquia

Acquia Environments API

The Environments API from Acquia — 73 operation(s) for environments.

GitHub OpenAPI

Operations 102

DELETE /environments/{environmentId} Acquia Deletes a CD Environment. #
GET /environments/{environmentId} Acquia Return Details About a Specific Environment. #
OPTIONS /environments/{environmentId} Acquia Displays Environment Options. #
PUT /environments/{environmentId} Acquia Modifies Configuration Settings for an Environment. #
POST /environments/{environmentId}/actions/change-label Acquia Change the Label for an Environment. #
POST /environments/{environmentId}/actions/clear-caches Acquia Clears the Caches for One or More Domains Attached to This Environment. #
POST /environments/{environmentId}/artifacts/actions/switch Acquia Deploys an Artifact to This Environment. #
GET /environments/{environmentId}/available-runtimes Acquia Return a List of Runtimes. #
DELETE /environments/{environmentId}/cdn Acquia Disables a CDN for an Environment. #
GET /environments/{environmentId}/cdn Acquia Returns the CDN Status for an Environment. #
POST /environments/{environmentId}/cdn Acquia Enables a CDN for an Environment. #
GET /environments/{environmentId}/cloud-actions Acquia Returns a List of Cloud Actions. #
PUT /environments/{environmentId}/cloud-actions Acquia Modifies an Existing List of Cloud Actions. #
POST /environments/{environmentId}/cloud-actions/actions/disable Acquia Disables Cloud Actions. #
POST /environments/{environmentId}/cloud-actions/actions/enable Acquia Enables Cloud Actions. #
POST /environments/{environmentId}/cloud-actions/actions/reset Acquia Resets Cloud Actions. #
POST /environments/{environmentId}/code Acquia Deploys Code to This Environment. #
POST /environments/{environmentId}/code/actions/import Acquia Imports a Site to This Environment. #
POST /environments/{environmentId}/code/actions/switch Acquia Switches Code on This Environment to a Different Branch or Release Tag. #
GET /environments/{environmentId}/crons Acquia Return Environment Cron Jobs. #
POST /environments/{environmentId}/crons Acquia Creates a Scheduled Job with Cron. #
DELETE /environments/{environmentId}/crons/{cronId} Acquia Deletes a Cron Job. #
GET /environments/{environmentId}/crons/{cronId} Acquia Return Details About a Specific Cron Job. #
PUT /environments/{environmentId}/crons/{cronId} Acquia Modify an Existing Scheduled Job. #
POST /environments/{environmentId}/crons/{cronId}/actions/disable Acquia Disables a Cron Job. #
POST /environments/{environmentId}/crons/{cronId}/actions/enable Acquia Enables a Cron Job. #
GET /environments/{environmentId}/databases Acquia Returns a List of Databases. #
POST /environments/{environmentId}/databases Acquia Copies a Database to This Environment. #
GET /environments/{environmentId}/databases/{databaseName} Acquia Return Details About a Specific Database. #
GET /environments/{environmentId}/databases/{databaseName}/backups Acquia Returns a List of Backups. #
POST /environments/{environmentId}/databases/{databaseName}/backups Acquia Create a Backup. #
DELETE /environments/{environmentId}/databases/{databaseName}/backups/{backupId} Acquia Deletes a Database Backup. #
GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId} Acquia Return Details About a Specific Backup. #
GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download Acquia Downloads the Database Backup File. #
POST /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore Acquia Restores This Backup to the Appropriate Environment's Database. #
GET /environments/{environmentId}/databases/{databaseName}/php-config Acquia Returns PHP Configuration Details for This Database. #
GET /environments/{environmentId}/dns Acquia Returns DNS Configuration Details for an Environment. #
GET /environments/{environmentId}/domains Acquia Returns a List of Domains. #
POST /environments/{environmentId}/domains Acquia Adds a Domain to the Environment. #
POST /environments/{environmentId}/domains/actions/clear-varnish Acquia Clears the Varnish Cache for One or More Domains Attached to This Environment. #
DELETE /environments/{environmentId}/domains/{domain} Acquia Removes the Domain from This Environment. #
GET /environments/{environmentId}/domains/{domain} Acquia Return Details About a Specific Domain. #
POST /environments/{environmentId}/domains/{domain}/actions/clear-caches Acquia Clears the Caches for the Specified Domain. #
POST /environments/{environmentId}/domains/{domain}/actions/clear-varnish Acquia Clears the Varnish Cache for the Specified Domain. #
GET /environments/{environmentId}/domains/{domain}/status Acquia Returns Details About the Domain. #
GET /environments/{environmentId}/eips Acquia Return a List of Web EIPs. #
POST /environments/{environmentId}/files Acquia Copies Files to This Environment. #
POST /environments/{environmentId}/livedev/actions/disable Acquia Disable Live Development on This Environment. #
POST /environments/{environmentId}/livedev/actions/enable Acquia Enable Live Development on This Environment. #
GET /environments/{environmentId}/log-forwarding-destinations Acquia Returns a Collection of Log Forwarding Destinations for This Environment. #
POST /environments/{environmentId}/log-forwarding-destinations Acquia Creates a Log Forwarding Destination. #
DELETE /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Acquia Deletes the Specified Log Forwarding Destination. #
GET /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Acquia Returns the Specified Log Forwarding Destination. #
PUT /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Acquia Updates an Environment's Log Forwarding Destination. #
POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable Acquia Disables the Specified Log Forwarding Destination. #
POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable Acquia Enables the Specified Log Forwarding Destination. #
GET /environments/{environmentId}/logs Acquia Returns a List of Log Files for This Environment Available for Download. #
GET /environments/{environmentId}/logs/{logType} Acquia Downloads the Log File. #
POST /environments/{environmentId}/logs/{logType} Acquia Creates a Log File Snapshot. #
GET /environments/{environmentId}/logstream Acquia Returns a Logstream Url and Metadata. #
GET /environments/{environmentId}/metrics Acquia Does Not Return Any Data. Allows Traversal to Metrics Groups Endpoints. #
GET /environments/{environmentId}/metrics/stackmetrics Acquia Does Not Return Any Data. Allows Traversal to StackMetrics Endpoints. #
GET /environments/{environmentId}/metrics/stackmetrics/data Acquia Returns StackMetrics Data for the Metrics Specified in the Filter Paramater (e.g., Apache-access, Web-cpu). #
GET /environments/{environmentId}/metrics/usage/data Acquia Retrieves Usage Data for an Environment. #
GET /environments/{environmentId}/metrics/usage/{usageMetric} Acquia Retrieves Usage Metric Data for an Environment. #
GET /environments/{environmentId}/mod-proxy Acquia Returns the Mod Proxy Status for an Environment. #
POST /environments/{environmentId}/mod-proxy/actions/disable Acquia Disables Mod Proxy for an Environment. #
POST /environments/{environmentId}/mod-proxy/actions/enable Acquia Enables Mod Proxy for an Environment. #
GET /environments/{environmentId}/operating-systems Acquia Return a List of Operating Systems. #
POST /environments/{environmentId}/production-mode/actions/disable Acquia Disables Production Mode for an Environment. #
POST /environments/{environmentId}/production-mode/actions/enable Acquia Enables Production Mode for an Environment. #
GET /environments/{environmentId}/search Acquia Returns a Traversal Endpoint for Search Entities for the Environment. #
GET /environments/{environmentId}/search/indexes Acquia Returns a Collection of Search Indexes for an Environment. #
POST /environments/{environmentId}/search/indexes Acquia Creates a Search Index for an Environment. #
DELETE /environments/{environmentId}/search/indexes/{indexId} Acquia Removes and Deletes a Specific Search Index from an Environment #
GET /environments/{environmentId}/search/indexes/{indexId} Acquia Returns a Search Configuration Set for an Application #
PUT /environments/{environmentId}/search/indexes/{indexId} Acquia Updates a Search Index on an Environment. #
GET /environments/{environmentId}/servers Acquia Returns a List of Servers. #
GET /environments/{environmentId}/servers/{serverId} Acquia Return Details About a Specific Server. #
PUT /environments/{environmentId}/servers/{serverId} Acquia Modifies Configuration Settings for a Server. #
POST /environments/{environmentId}/servers/{serverId}/actions/reboot Acquia Reboots a Server. #
POST /environments/{environmentId}/servers/{serverId}/actions/relaunch Acquia Relaunches a Server. #
POST /environments/{environmentId}/servers/{serverId}/actions/suspend Acquia Suspends a Server. #
POST /environments/{environmentId}/servers/{serverId}/actions/upgrade Acquia Upgrades a Server from "precise" to "xenial". #
GET /environments/{environmentId}/settings Acquia Provides Links to Environment Settings. #
GET /environments/{environmentId}/ssl Acquia Returns the SSL Settings for This Environment. #
GET /environments/{environmentId}/ssl/certificates Acquia Return a List of SSL Certificates. #
POST /environments/{environmentId}/ssl/certificates Acquia Install an SSL Certificate. #
DELETE /environments/{environmentId}/ssl/certificates/{certificateId} Acquia Deletes a Specific Certificate by its ID. #
GET /environments/{environmentId}/ssl/certificates/{certificateId} Acquia Returns a Specific Certificate by Certificate Id. #
POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate Acquia Activates an SSL Certificate. #
POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate Acquia Deactivates an Active SSL Certificate. #
GET /environments/{environmentId}/ssl/csrs Acquia Returns Certificate Signing Requests. #
POST /environments/{environmentId}/ssl/csrs Acquia Generates a Certificate Signing Request (CSR) for One or More Domains. #
DELETE /environments/{environmentId}/ssl/csrs/{certificateId} Acquia Deletes the Certificate Signing Request. #
GET /environments/{environmentId}/ssl/csrs/{certificateId} Acquia Returns the Certificate Signing Request for the Certificate Specified by Id. #
GET /environments/{environmentId}/variables Acquia Returns a List of Environment Variables Associated with This Environment. #
POST /environments/{environmentId}/variables Acquia Adds a New Environment Variable to an Environment. #
DELETE /environments/{environmentId}/variables/{environmentVariableName} Acquia Removes an Environment Variable from an Environment. #
GET /environments/{environmentId}/variables/{environmentVariableName} Acquia Get an Environment Variable Associated with This Environment. #
PUT /environments/{environmentId}/variables/{environmentVariableName} Acquia Updates an Environment Variable on an Environment. #

Documentation

📖
Documentation
https://cloudapi-docs.acquia.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-environments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/acquia-environments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

acquia-environments-api-openapi.yml Raw ↑ 
openapi: 3.2.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:
- url: https://cloud.acquia.com/api
  description: Promoted from the path-level servers[] already present in this document
    (API Evangelist 2026-08-30); the top-level block was empty.
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:
 

# --- 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