Acquia

Acquia Environments API

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

GitHub OpenAPI

Operations 102

GET /environments/{environmentId} Return details about a specific environment #
PUT /environments/{environmentId} Modifies configuration settings for an environment #
DELETE /environments/{environmentId} Deletes a CD environment #
OPTIONS /environments/{environmentId} Displays environment options #
POST /environments/{environmentId}/actions/clear-caches Clears the caches for one or more domains attached to this environment #
POST /environments/{environmentId}/actions/change-label Change the label for an environment #
POST /environments/{environmentId}/artifacts/actions/switch Deploys an artifact to this environment #
GET /environments/{environmentId}/operating-systems Return a list of operating systems #
GET /environments/{environmentId}/available-runtimes Return a list of runtimes #
GET /environments/{environmentId}/cdn Returns the CDN status for an environment #
POST /environments/{environmentId}/cdn Enables a CDN for an environment #
DELETE /environments/{environmentId}/cdn Disables a CDN for an environment #
GET /environments/{environmentId}/cloud-actions Returns a list of Cloud Actions #
PUT /environments/{environmentId}/cloud-actions Modifies an existing list of Cloud Actions #
POST /environments/{environmentId}/cloud-actions/actions/disable Disables Cloud Actions #
POST /environments/{environmentId}/cloud-actions/actions/enable Enables Cloud Actions #
POST /environments/{environmentId}/cloud-actions/actions/reset Resets Cloud Actions #
POST /environments/{environmentId}/code Deploys code to this environment #
POST /environments/{environmentId}/code/actions/switch Switches code on this environment to a different branch or release tag #
POST /environments/{environmentId}/code/actions/import Imports a site to this environment #
GET /environments/{environmentId}/crons Return environment cron jobs #
POST /environments/{environmentId}/crons Creates a scheduled job with cron #
GET /environments/{environmentId}/crons/{cronId} Return details about a specific cron job #
PUT /environments/{environmentId}/crons/{cronId} Modify an existing scheduled job #
DELETE /environments/{environmentId}/crons/{cronId} Deletes a cron job #
POST /environments/{environmentId}/crons/{cronId}/actions/enable Enables a cron job #
POST /environments/{environmentId}/crons/{cronId}/actions/disable Disables a cron job #
GET /environments/{environmentId}/databases Returns a list of databases #
POST /environments/{environmentId}/databases Copies a database to this environment #
GET /environments/{environmentId}/databases/{databaseName} Return details about a specific database #
GET /environments/{environmentId}/databases/{databaseName}/php-config Returns PHP configuration details for this database #
GET /environments/{environmentId}/databases/{databaseName}/backups Returns a list of backups #
POST /environments/{environmentId}/databases/{databaseName}/backups Create a backup #
GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId} Return details about a specific backup #
DELETE /environments/{environmentId}/databases/{databaseName}/backups/{backupId} Deletes a database backup #
GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download Downloads the database backup file #
POST /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore Restores this backup to the appropriate environment's database #
GET /environments/{environmentId}/dns Returns DNS configuration details for an environment #
GET /environments/{environmentId}/domains Returns a list of domains #
POST /environments/{environmentId}/domains Adds a domain to the environment #
POST /environments/{environmentId}/domains/actions/clear-varnish Clears the Varnish cache for one or more domains attached to this environment #
GET /environments/{environmentId}/domains/{domain} Return details about a specific domain #
DELETE /environments/{environmentId}/domains/{domain} Removes the domain from this environment #
POST /environments/{environmentId}/domains/{domain}/actions/clear-varnish Clears the Varnish cache for the specified domain #
POST /environments/{environmentId}/domains/{domain}/actions/clear-caches Clears the caches for the specified domain #
GET /environments/{environmentId}/domains/{domain}/status Returns details about the domain #
GET /environments/{environmentId}/eips Return a list of Web EIPs #
POST /environments/{environmentId}/files Copies files to this environment #
GET /environments/{environmentId}/logs Returns a list of log files for this environment available for download #
GET /environments/{environmentId}/logs/{logType} Downloads the log file #
POST /environments/{environmentId}/logs/{logType} Creates a log file snapshot #
GET /environments/{environmentId}/logstream Returns a logstream url and metadata #
POST /environments/{environmentId}/livedev/actions/disable Disable Live Development on this environment #
POST /environments/{environmentId}/livedev/actions/enable Enable Live Development on this environment #
GET /environments/{environmentId}/log-forwarding-destinations Returns a collection of log forwarding destinations for this environment #
POST /environments/{environmentId}/log-forwarding-destinations Creates a log forwarding destination #
GET /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Returns the specified log forwarding destination #
PUT /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Updates an environment's log forwarding destination #
DELETE /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Deletes the specified log forwarding destination #
POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable Disables the specified log forwarding destination #
POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable Enables the specified log forwarding destination #
GET /environments/{environmentId}/metrics Does not return any data. Allows traversal to metrics groups endpoints #
GET /environments/{environmentId}/metrics/stackmetrics Does not return any data. Allows traversal to StackMetrics endpoints #
GET /environments/{environmentId}/metrics/stackmetrics/data Returns StackMetrics data for the metrics specified in the filter paramater… #
GET /environments/{environmentId}/metrics/usage/data Retrieves usage data for an environment #
GET /environments/{environmentId}/metrics/usage/{usageMetric} Retrieves usage metric data for an environment #
GET /environments/{environmentId}/mod-proxy Returns the mod proxy status for an Environment #
POST /environments/{environmentId}/mod-proxy/actions/disable Disables mod proxy for an environment #
POST /environments/{environmentId}/mod-proxy/actions/enable Enables mod proxy for an environment #
POST /environments/{environmentId}/production-mode/actions/disable Disables production mode for an environment #
POST /environments/{environmentId}/production-mode/actions/enable Enables production mode for an environment #
GET /environments/{environmentId}/search Returns a traversal endpoint for search entities for the environment #
GET /environments/{environmentId}/search/indexes Returns a collection of search indexes for an environment #
POST /environments/{environmentId}/search/indexes Creates a search index for an environment #
GET /environments/{environmentId}/search/indexes/{indexId} Returns a search configuration set for an application #
PUT /environments/{environmentId}/search/indexes/{indexId} Updates a search index on an environment #
DELETE /environments/{environmentId}/search/indexes/{indexId} Removes and deletes a specific search index from an environment #
GET /environments/{environmentId}/servers Returns a list of servers #
GET /environments/{environmentId}/servers/{serverId} Return details about a specific server #
PUT /environments/{environmentId}/servers/{serverId} Modifies configuration settings for a server #
POST /environments/{environmentId}/servers/{serverId}/actions/reboot Reboots a server #
POST /environments/{environmentId}/servers/{serverId}/actions/relaunch Relaunches a server #
POST /environments/{environmentId}/servers/{serverId}/actions/suspend Suspends a server #
POST /environments/{environmentId}/servers/{serverId}/actions/upgrade Upgrades a server from "precise" to "xenial" #
GET /environments/{environmentId}/settings Provides links to environment settings #
GET /environments/{environmentId}/ssl Returns the SSL settings for this environment #
GET /environments/{environmentId}/ssl/certificates Return a list of SSL certificates #
POST /environments/{environmentId}/ssl/certificates Install an SSL certificate #
GET /environments/{environmentId}/ssl/certificates/{certificateId} Returns a specific certificate by certificate id #
DELETE /environments/{environmentId}/ssl/certificates/{certificateId} Deletes a specific certificate by its ID #
POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate Activates an SSL certificate #
POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate Deactivates an active SSL certificate #
GET /environments/{environmentId}/ssl/csrs Returns certificate signing requests #
POST /environments/{environmentId}/ssl/csrs Generates a certificate signing request (CSR) for one or more domains #
GET /environments/{environmentId}/ssl/csrs/{certificateId} Returns the certificate signing request for the certificate specified by id #
DELETE /environments/{environmentId}/ssl/csrs/{certificateId} Deletes the certificate signing request #
GET /environments/{environmentId}/variables Returns a list of environment variables associated with this environment #
POST /environments/{environmentId}/variables Adds a new environment variable to an environment #
GET /environments/{environmentId}/variables/{environmentVariableName} Get an environment variable associated with this environment #
DELETE /environments/{environmentId}/variables/{environmentVariableName} Removes an environment variable from an environment #
PUT /environments/{environmentId}/variables/{environmentVariableName} 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:
  title: Acquia Cloud API Documentation Environments API
  x-logo:
    url: assets/cloud-platform.svg
    backgroundColor: '#FFFFFF'
    altText: Acquia Cloud
  description: 'Acquia Cloud API


    # Compatibility


    ## Stability


    The 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.'
  version: 2.0.0
  contact:
    name: Customer Experience Engineering (CXE)
    url: https://www.acquia.com
tags:


# --- truncated at 32 KB (452 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-environments-api-openapi.yml