Acquia

Acquia Environments API

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

GitHub OpenAPI
Business capability
Environment Management BC-4210.20

Operations 102

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /environments/{environmentId} View details of one environment · Return details about a specific environment #
Ask an LLM
“What are the settings and status of a specific Acquia environment?”
“Can I pull up an environment's details by its ID?”
Tell an agent
Get the details of environment {env}.
Show me everything about environment {env}.
PUT /environments/{environmentId} Change PHP and runtime settings on an environment · Modifies configuration settings for an environment #
Ask an LLM
“How do I raise the PHP memory limit on an environment?”
“Can I change the PHP version or max execution time for one environment?”
Tell an agent
Set the PHP version on environment {env} to {version}.
Raise the PHP memory limit on environment {env} to {memory_limit}.
DELETE /environments/{environmentId} Delete a CD environment · Deletes a CD environment #
Ask an LLM
“Can I tear down a continuous delivery environment I no longer need?”
“What's the way to delete a CD environment by its ID?”
Tell an agent destructive · confirm first
Delete CD environment {env}.
Tear down continuous delivery environment {env}.
OPTIONS /environments/{environmentId} See configurable options for an environment · Displays environment options #
Ask an LLM
“What configuration options are allowed for this environment?”
“Which values can I choose from before modifying an environment?”
Tell an agent
Show the available options for environment {env}.
Display the allowed configuration choices on environment {env}.
POST /environments/{environmentId}/actions/clear-caches Clear Varnish and CDN caches for several domains · Clears the caches for one or more domains attached to this environment #
Ask an LLM
“Can I purge both Varnish and Platform CDN caches for a batch of domains at once?”
“What clears the full cache for multiple domains on one environment?”
Tell an agent
Clear Varnish and CDN caches for domains {domains} on environment {env}.
Purge all caches, CDN included, for {domains} on environment {env}.
POST /environments/{environmentId}/actions/change-label Rename an environment's label · Change the label for an environment #
Ask an LLM
“How do I change the display label of an environment?”
“Can I rename an environment to something more descriptive?”
Tell an agent
Change the label of environment {env} to {label}.
Relabel environment {env} as {label}.
POST /environments/{environmentId}/artifacts/actions/switch Deploy a build artifact to an environment · Deploys an artifact to this environment #
Ask an LLM
“Can I deploy a specific build artifact to an environment?”
“What switches an environment over to a different artifact?”
Tell an agent
Deploy artifact {artifact} to environment {env}.
Switch environment {env} to build artifact {artifact}.
GET /environments/{environmentId}/operating-systems List operating systems for an environment · Return a list of operating systems #
Ask an LLM
“Which operating systems can this environment run on?”
“What OS options are offered for an environment?”
Tell an agent
List the operating systems available to environment {env}.
Show OS choices for environment {env}.
GET /environments/{environmentId}/available-runtimes List runtimes available to an environment · Return a list of runtimes #
Ask an LLM
“What runtimes can I pick for this environment?”
“Which runtime versions are available before I upgrade an environment?”
Tell an agent
List the available runtimes for environment {env}.
Show which runtimes environment {env} can switch to.
GET /environments/{environmentId}/cdn Check CDN status on an environment · Returns the CDN status for an environment #
Ask an LLM
“Is the CDN enabled and healthy on this environment?”
“What's the current CDN status for one of my environments?”
Tell an agent
Check the CDN status on environment {env}.
Tell me whether the CDN is on for environment {env}.
POST /environments/{environmentId}/cdn Enable the CDN on an environment · Enables a CDN for an environment #
Ask an LLM
“How do I turn on the CDN for an environment?”
“Can I put a CDN in front of one environment?”
Tell an agent
Enable the CDN on environment {env}.
Turn on CDN delivery for environment {env}.
DELETE /environments/{environmentId}/cdn Disable the CDN on an environment · Disables a CDN for an environment #
Ask an LLM
“Can I switch off the CDN for an environment?”
“What removes CDN delivery from an environment?”
Tell an agent destructive · confirm first
Disable the CDN on environment {env}.
Turn off CDN delivery for environment {env}.
GET /environments/{environmentId}/cloud-actions List Cloud Actions configured on an environment · Returns a list of Cloud Actions #
Ask an LLM
“Which Cloud Actions run on this environment after a deploy?”
“What post-deploy actions are configured for an environment?”
Tell an agent
List the Cloud Actions on environment {env}.
Show which Cloud Actions are set for environment {env}.
PUT /environments/{environmentId}/cloud-actions Change the set of Cloud Actions on an environment · Modifies an existing list of Cloud Actions #
Ask an LLM
“Can I edit which Cloud Actions run on an environment?”
“How do I replace the Cloud Actions list for an environment?”
Tell an agent
Set the Cloud Actions on environment {env} to {cloud_actions}.
Update environment {env} so its Cloud Actions are {cloud_actions}.
POST /environments/{environmentId}/cloud-actions/actions/disable Turn off Cloud Actions on an environment · Disables Cloud Actions #
Ask an LLM
“Can I stop Cloud Actions from running on an environment?”
“What disables all Cloud Actions for one environment?”
Tell an agent
Disable Cloud Actions on environment {env}.
Stop Cloud Actions from running on environment {env}.
POST /environments/{environmentId}/cloud-actions/actions/enable Turn on Cloud Actions on an environment · Enables Cloud Actions #
Ask an LLM
“How do I re-enable Cloud Actions that were switched off?”
“Can Cloud Actions be turned back on for an environment?”
Tell an agent
Enable Cloud Actions on environment {env}.
Switch Cloud Actions back on for environment {env}.
POST /environments/{environmentId}/cloud-actions/actions/reset Reset Cloud Actions to defaults · Resets Cloud Actions #
Ask an LLM
“Can I restore an environment's Cloud Actions to the default set?”
“What undoes my custom Cloud Actions changes on an environment?”
Tell an agent
Reset Cloud Actions on environment {env} to the defaults.
Restore the default Cloud Actions for environment {env}.
POST /environments/{environmentId}/code Deploy code from another environment · Deploys code to this environment #
Ask an LLM
“How do I promote code from staging to production?”
“Can I attach a deploy message when pushing code to an environment?”
Tell an agent
Deploy code from environment {source} to environment {env}.
Promote the code on {source} to environment {env} with message {message}.
POST /environments/{environmentId}/code/actions/switch Switch an environment to a branch or tag · Switches code on this environment to a different branch or release tag #
Ask an LLM
“Can I point an environment at a different git branch or release tag?”
“What checks out a new branch on a single environment?”
Tell an agent
Switch environment {env} to branch or tag {branch}.
Check out {branch} on environment {env}.
POST /environments/{environmentId}/code/actions/import Import a site into an environment · Imports a site to this environment #
Ask an LLM
“Can I import an existing site archive from a URL into an environment?”
“What brings an external site into one of my environments?”
Tell an agent
Import the site at {url} into environment {env}.
Import site {name} from {url} to environment {env}.
GET /environments/{environmentId}/crons List cron jobs on an environment · Return environment cron jobs #
Ask an LLM
“Which scheduled cron jobs are set up on this environment?”
“What cron tasks run on an environment?”
Tell an agent
List the cron jobs on environment {env}.
Show all scheduled jobs for environment {env}.
POST /environments/{environmentId}/crons Schedule a new cron job · Creates a scheduled job with cron #
Ask an LLM
“How do I schedule a drush command to run every hour?”
“Can I add a new cron job with its own label and frequency?”
Tell an agent
Create a cron job {label} on environment {env} running {command} at {frequency}.
Schedule {command} on environment {env} with cron frequency {frequency}, labeled {label}.
GET /environments/{environmentId}/crons/{cronId} View one cron job · Return details about a specific cron job #
Ask an LLM
“What command and schedule does a specific cron job use?”
“Is a particular cron job enabled?”
Tell an agent
Get cron job {cron} on environment {env}.
Show the schedule and command of cron {cron} in environment {env}.
PUT /environments/{environmentId}/crons/{cronId} Edit an existing cron job · Modify an existing scheduled job #
Ask an LLM
“Can I change how often an existing cron job runs?”
“What updates the command of a scheduled job I already created?”
Tell an agent
Change cron job {cron} on environment {env} to run at {frequency}.
Update existing cron {cron} in environment {env} to run command {command}.
DELETE /environments/{environmentId}/crons/{cronId} Delete a cron job · Deletes a cron job #
Ask an LLM
“Can I permanently remove a cron job from an environment?”
“What deletes a scheduled job rather than just pausing it?”
Tell an agent destructive · confirm first
Delete cron job {cron} from environment {env}.
Remove scheduled job {cron} on environment {env} for good.
POST /environments/{environmentId}/crons/{cronId}/actions/enable Enable a paused cron job · Enables a cron job #
Ask an LLM
“How do I resume a cron job that was disabled?”
“Can I switch a paused scheduled job back on?”
Tell an agent
Enable cron job {cron} on environment {env}.
Resume scheduled job {cron} in environment {env}.
POST /environments/{environmentId}/crons/{cronId}/actions/disable Pause a cron job · Disables a cron job #
Ask an LLM
“Can I pause a cron job without deleting it?”
“What temporarily stops a scheduled job from running?”
Tell an agent
Disable cron job {cron} on environment {env}.
Pause scheduled job {cron} in environment {env} without deleting it.
GET /environments/{environmentId}/databases List databases on an environment · Returns a list of databases #
Ask an LLM
“Which databases exist on this environment?”
“Can I filter an environment's databases by name?”
Tell an agent
List the databases on environment {env}.
Find databases on environment {env} matching {filter}.
POST /environments/{environmentId}/databases Copy a database from another environment · Copies a database to this environment #
Ask an LLM
“How do I copy the production database down to staging?”
“Can I copy one named database from another environment into this one?”
Tell an agent
Copy database {name} from environment {source} to environment {env}.
Bring database {name} over from {source} into environment {env}.
GET /environments/{environmentId}/databases/{databaseName} View one database on an environment · Return details about a specific database #
Ask an LLM
“What are the connection details and info for a specific database?”
“Can I look up one database on an environment by name?”
Tell an agent
Get database {database} on environment {env}.
Show the details of the {database} database in environment {env}.
GET /environments/{environmentId}/databases/{databaseName}/php-config Get PHP configuration for a database · Returns PHP configuration details for this database #
Ask an LLM
“What PHP settings file does my app need to connect to a database?”
“Can I fetch the PHP config snippet for a specific database?”
Tell an agent
Show the PHP configuration for database {database} on environment {env}.
Get PHP connection settings for {database} in environment {env}.
GET /environments/{environmentId}/databases/{databaseName}/backups List backups of a database · Returns a list of backups #
Ask an LLM
“What backups exist for my production database?”
“Can I list database backups taken within a date range?”
Tell an agent
List backups of database {database} on environment {env}.
Show backups of {database} in environment {env} created between {from} and {to}.
POST /environments/{environmentId}/databases/{databaseName}/backups Take an on-demand database backup · Create a backup #
Ask an LLM
“How do I back up a database right before a risky deploy?”
“Can I trigger a manual database backup now?”
Tell an agent
Create a backup of database {database} on environment {env}.
Back up {database} in environment {env} right now.
GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId} View one database backup · Return details about a specific backup #
Ask an LLM
“When was a specific backup taken and what type is it?”
“Can I look up the details of a single database backup?”
Tell an agent
Get backup {backup} of database {database} on environment {env}.
Show details for backup {backup} of {database} in environment {env}.
DELETE /environments/{environmentId}/databases/{databaseName}/backups/{backupId} Delete a database backup · Deletes a database backup #
Ask an LLM
“Can I delete an old database backup I no longer need?”
“What removes a specific backup permanently?”
Tell an agent destructive · confirm first
Delete backup {backup} of database {database} on environment {env}.
Remove database backup {backup} for {database} from environment {env}.
GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download Download a database backup file · Downloads the database backup file #
Ask an LLM
“How do I download a database backup to my machine?”
“Can I get the backup file itself rather than just its metadata?”
Tell an agent
Download backup {backup} of database {database} from environment {env}.
Get the file for {database} backup {backup} on environment {env}.
POST /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore Restore a database from a backup · Restores this backup to the appropriate environment's database #
Ask an LLM
“Can I roll a database back to an earlier backup after a bad deploy?”
“What restores a backup over the current database?”
Tell an agent destructive · confirm first
Restore backup {backup} to database {database} on environment {env}.
Roll {database} in environment {env} back to backup {backup}.
GET /environments/{environmentId}/dns Get DNS setup details for an environment · Returns DNS configuration details for an environment #
Ask an LLM
“What DNS records should I point my apex domain and subdomains at?”
“Which IPs and CNAMEs does an environment expect for DNS?”
Tell an agent
Show the DNS configuration for environment {env}.
Tell me what DNS records to set for environment {env}.
GET /environments/{environmentId}/domains List domains attached to an environment · Returns a list of domains #
Ask an LLM
“Which domains are attached to this environment?”
“Can I search an environment's domains by hostname?”
Tell an agent
List the domains on environment {env}.
Find domains on environment {env} with hostname matching {filter}.
POST /environments/{environmentId}/domains Add a domain to an environment · Adds a domain to the environment #
Ask an LLM
“How do I attach a new hostname to an environment?”
“Can I add a custom domain to my production environment?”
Tell an agent
Add domain {hostname} to environment {env}.
Attach hostname {hostname} to environment {env}.
POST /environments/{environmentId}/domains/actions/clear-varnish Clear Varnish only for several domains · Clears the Varnish cache for one or more domains attached to this environment #
Ask an LLM
“Can I flush just the Varnish cache for a list of domains, leaving the CDN alone?”
“What purges Varnish for multiple domains in one request?”
Tell an agent
Clear only the Varnish cache for domains {domains} on environment {env}.
Flush Varnish for the domain list {domains} in environment {env}.
GET /environments/{environmentId}/domains/{domain} View one domain on an environment · Return details about a specific domain #
Ask an LLM
“What are the details of a specific domain on my environment?”
“Is a particular hostname attached to this environment?”
Tell an agent
Get domain {domain} on environment {env}.
Show the record for hostname {domain} in environment {env}.
DELETE /environments/{environmentId}/domains/{domain} Remove a domain from an environment · Removes the domain from this environment #
Ask an LLM
“Can I detach a hostname I no longer use from an environment?”
“What removes a domain from an environment?”
Tell an agent destructive · confirm first
Remove domain {domain} from environment {env}.
Detach hostname {domain} from environment {env}.
POST /environments/{environmentId}/domains/{domain}/actions/clear-varnish Clear Varnish for a single domain · Clears the Varnish cache for the specified domain #
Ask an LLM
“Can I purge the Varnish cache for just one domain?”
“What flushes Varnish for a single hostname without touching the CDN?”
Tell an agent
Clear the Varnish cache for domain {domain} on environment {env}.
Flush Varnish only for hostname {domain} in environment {env}.
POST /environments/{environmentId}/domains/{domain}/actions/clear-caches Clear all caches for a single domain · Clears the caches for the specified domain #
Ask an LLM
“How do I purge both Varnish and the Platform CDN for one domain?”
“Can I clear every cache layer for a single hostname?”
Tell an agent
Clear Varnish and CDN caches for domain {domain} on environment {env}.
Purge every cache layer for hostname {domain} in environment {env}.
GET /environments/{environmentId}/domains/{domain}/status Check the status of a domain · Returns details about the domain #
Ask an LLM
“Is my domain resolving and active on the environment?”
“What's the current status of a hostname I attached?”
Tell an agent
Check the status of domain {domain} on environment {env}.
Tell me whether hostname {domain} is live on environment {env}.
GET /environments/{environmentId}/eips List web elastic IPs for an environment · Return a list of Web EIPs #
Ask an LLM
“What static web IP addresses does this environment use?”
“Which Web EIPs should I allowlist for an environment?”
Tell an agent
List the Web EIPs for environment {env}.
Show the elastic IP addresses of environment {env}.
POST /environments/{environmentId}/files Copy files from another environment · Copies files to this environment #
Ask an LLM
“How do I copy uploaded files from production to a dev environment?”
“Can I sync the files directory between two environments?”
Tell an agent
Copy files from environment {source} to environment {env}.
Sync the files directory of {source} into environment {env}.
GET /environments/{environmentId}/logs List downloadable log files · Returns a list of log files for this environment available for download #
Ask an LLM
“Which log files can I download for an environment?”
“What log types are available on this environment?”
Tell an agent
List the downloadable log files for environment {env}.
Show which log types environment {env} offers.
GET /environments/{environmentId}/logs/{logType} Download a log file · Downloads the log file #
Ask an LLM
“Can I download the Apache or PHP error log for an environment?”
“What fetches a log file once its snapshot is ready?”
Tell an agent
Download the {log_type} log from environment {env}.
Get the {log_type} log file for environment {env}.
POST /environments/{environmentId}/logs/{logType} Create a log file snapshot · Creates a log file snapshot #
Ask an LLM
“How do I generate a fresh snapshot of a log before downloading it?”
“Can I snapshot a log for a specific time window?”
Tell an agent
Create a snapshot of the {log_type} log on environment {env}.
Snapshot the {log_type} log for environment {env} from {from} to {to}.
GET /environments/{environmentId}/logstream Get a live logstream URL · Returns a logstream url and metadata #
Ask an LLM
“Can I tail an environment's logs in real time?”
“Where do I get the logstream connection URL and metadata?”
Tell an agent
Get the logstream URL for environment {env}.
Give me live log streaming details for environment {env}.
POST /environments/{environmentId}/livedev/actions/disable Turn off Live Development · Disable Live Development on this environment #
Ask an LLM
“Can I turn off Live Development and throw away uncommitted changes?”
“What disables Live Development on an environment?”
Tell an agent
Disable Live Development on environment {env}.
Turn off Live Development on environment {env}, discard setting {discard}.
POST /environments/{environmentId}/livedev/actions/enable Turn on Live Development · Enable Live Development on this environment #
Ask an LLM
“How do I enable Live Development so I can edit code directly on the server?”
“Is Live Development supported on Acquia Cloud Next environments?”
Tell an agent
Enable Live Development on environment {env}.
Switch environment {env} into Live Development mode.
GET /environments/{environmentId}/log-forwarding-destinations List log forwarding destinations · Returns a collection of log forwarding destinations for this environment #
Ask an LLM
“Where are this environment's logs being forwarded?”
“Can I filter log forwarding destinations by label or consumer?”
Tell an agent
List the log forwarding destinations for environment {env}.
Find log forwarding destinations on environment {env} matching {filter}.
POST /environments/{environmentId}/log-forwarding-destinations Set up a log forwarding destination · Creates a log forwarding destination #
Ask an LLM
“How do I ship an environment's logs to my logging service?”
“Can I choose which log sources get forwarded to a new destination?”
Tell an agent
Create log forwarding destination {label} on environment {env} to consumer {consumer} for sources {sources} with credentials {credentials}.
Forward {sources} logs from environment {env} to {address} via {consumer}, labeled {label}, using {credentials}.
GET /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} View one log forwarding destination · Returns the specified log forwarding destination #
Ask an LLM
“What sources and address does a specific log forwarding destination use?”
“Can I inspect one log forwarding setup by its UUID?”
Tell an agent
Get log forwarding destination {destination} on environment {env}.
Show the settings of log destination {destination} in environment {env}.
PUT /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Edit a log forwarding destination · Updates an environment's log forwarding destination #
Ask an LLM
“Can I change the address or credentials of an existing log forwarding destination?”
“What updates the log sources an existing destination receives?”
Tell an agent
Update log destination {destination} on environment {env} to send to {address} via {consumer}.
Change the sources of existing log destination {destination} in environment {env} to {sources}, consumer {consumer}.
DELETE /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} Delete a log forwarding destination · Deletes the specified log forwarding destination #
Ask an LLM
“Can I permanently remove a log forwarding destination?”
“What stops and deletes a log forwarding setup for good?”
Tell an agent destructive · confirm first
Delete log forwarding destination {destination} from environment {env}.
Remove log destination {destination} on environment {env} permanently.
POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable Pause a log forwarding destination · Disables the specified log forwarding destination #
Ask an LLM
“Can I pause log forwarding to a destination without deleting it?”
“What temporarily stops logs flowing to one destination?”
Tell an agent
Disable log forwarding destination {destination} on environment {env}.
Pause log shipping to destination {destination} in environment {env}.
POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable Resume a log forwarding destination · Enables the specified log forwarding destination #
Ask an LLM
“How do I turn log forwarding back on for a paused destination?”
“Can I re-enable a disabled log forwarding destination?”
Tell an agent
Enable log forwarding destination {destination} on environment {env}.
Resume sending logs to destination {destination} in environment {env}.
GET /environments/{environmentId}/metrics Browse metrics groups for an environment · Does not return any data. Allows traversal to metrics groups endpoints #
Ask an LLM
“What metrics groups can I navigate to for an environment?”
“Where do the environment metrics endpoints start?”
Tell an agent
Show the metrics group links for environment {env}.
Open the metrics index for environment {env}.
GET /environments/{environmentId}/metrics/stackmetrics Browse StackMetrics endpoints for an environment · Does not return any data. Allows traversal to StackMetrics endpoints #
Ask an LLM
“Which StackMetrics endpoints are linked from an environment?”
“Where do I navigate to reach StackMetrics for my environment?”
Tell an agent
Show the StackMetrics links for environment {env}.
Open the StackMetrics index of environment {env}.
GET /environments/{environmentId}/metrics/stackmetrics/data Get server metrics like CPU and Apache traffic · Returns StackMetrics data for the metrics specified in the filter paramater… #
Ask an LLM
“How do I see web CPU usage for an environment over the last day?”
“Can I pull apache-access metrics at a chosen resolution?”
Tell an agent
Get StackMetrics {filter} data for environment {env} starting {from}.
Pull {filter} metrics on environment {env} from {from} to {to} at {resolution} resolution.
GET /environments/{environmentId}/metrics/usage/data Get views and visits usage for an environment · Retrieves usage data for an environment #
Ask an LLM
“How many page views and visits did an environment get?”
“Can I break down an environment's traffic usage by resolution?”
Tell an agent
Get views and visits usage data for environment {env}.
Show usage for environment {env} filtered by {filter} at {resolution} resolution.
GET /environments/{environmentId}/metrics/usage/{usageMetric} Get one usage metric for an environment · Retrieves usage metric data for an environment #
Ask an LLM
“Can I get data for just one usage metric, like visits, on an environment?”
“What does a single named usage metric show for my environment?”
Tell an agent
Get the {metric} usage metric for environment {env}.
Show {metric} usage on environment {env} filtered by {filter}.
GET /environments/{environmentId}/mod-proxy Check mod proxy status on an environment · Returns the mod proxy status for an Environment #
Ask an LLM
“Is mod proxy turned on for this environment?”
“What's the current mod proxy state of an environment?”
Tell an agent
Check mod proxy status on environment {env}.
Tell me whether mod proxy is enabled for environment {env}.
POST /environments/{environmentId}/mod-proxy/actions/disable Disable mod proxy on an environment · Disables mod proxy for an environment #
Ask an LLM
“Can I switch off mod proxy for an environment?”
“What turns mod proxy off?”
Tell an agent
Disable mod proxy on environment {env}.
Turn mod proxy off for environment {env}.
POST /environments/{environmentId}/mod-proxy/actions/enable Enable mod proxy on an environment · Enables mod proxy for an environment #
Ask an LLM
“How do I turn on mod proxy for an environment?”
“Can mod proxy be enabled through the API?”
Tell an agent
Enable mod proxy on environment {env}.
Turn mod proxy on for environment {env}.
POST /environments/{environmentId}/production-mode/actions/disable Take an environment out of production mode · Disables production mode for an environment #
Ask an LLM
“Can I remove production-mode protection so files and databases can be copied in?”
“What takes an environment out of production mode?”
Tell an agent
Disable production mode on environment {env}.
Remove production protection from environment {env}.
POST /environments/{environmentId}/production-mode/actions/enable Put an environment into production mode · Enables production mode for an environment #
Ask an LLM
“How do I stop anyone from copying files or databases over my production environment?”
“What does enabling production mode protect against?”
Tell an agent
Enable production mode on environment {env}.
Protect environment {env} by switching on production mode.
GET /environments/{environmentId}/search Browse search entity links for an environment · Returns a traversal endpoint for search entities for the environment #
Ask an LLM
“Which search endpoints can I navigate to from an environment?”
“Where does the search entity index for an environment start?”
Tell an agent
Show the search entity links for environment {env}.
Open the search index navigation for environment {env}.
GET /environments/{environmentId}/search/indexes List search indexes on an environment · Returns a collection of search indexes for an environment #
Ask an LLM
“What search indexes exist on this environment?”
“Which Solr search indexes are attached to an environment?”
Tell an agent
List the search indexes on environment {env}.
Show every search index in environment {env}.
POST /environments/{environmentId}/search/indexes Create a search index on an environment · Creates a search index for an environment #
Ask an LLM
“How do I add a new search index for a database role on an environment?”
“Can I create a search index using a specific configuration set?”
Tell an agent
Create a search index on environment {env} for database role {database_role}.
Add a search index to environment {env} for {database_role} using config set {config_set}.
GET /environments/{environmentId}/search/indexes/{indexId} View one search index on an environment · Returns a search configuration set for an application #
Ask an LLM
“What configuration set does a specific search index use?”
“Can I look up one search index by its ID?”
Tell an agent
Get search index {index} on environment {env}.
Show the configuration of search index {index} in environment {env}.
PUT /environments/{environmentId}/search/indexes/{indexId} Change a search index's configuration set · Updates a search index on an environment #
Ask an LLM
“Can I switch an existing search index to a different configuration set?”
“What updates a search index already on an environment?”
Tell an agent
Update search index {index} on environment {env} to use config set {config_set}.
Change the configuration set of existing index {index} in environment {env} to {config_set}.
DELETE /environments/{environmentId}/search/indexes/{indexId} Delete a search index · Removes and deletes a specific search index from an environment #
Ask an LLM
“Can I remove a search index I no longer need from an environment?”
“What permanently deletes a search index?”
Tell an agent destructive · confirm first
Delete search index {index} from environment {env}.
Remove index {index} from environment {env} permanently.
GET /environments/{environmentId}/servers List servers behind an environment · Returns a list of servers #
Ask an LLM
“Which servers power this environment and where are they?”
“Can I filter an environment's servers by region or status?”
Tell an agent
List the servers for environment {env}.
Find servers in environment {env} matching {filter}.
GET /environments/{environmentId}/servers/{serverId} View one server · Return details about a specific server #
Ask an LLM
“What are the hostname, IP and status of a specific server?”
“Can I look up a single server in an environment?”
Tell an agent
Get server {server} in environment {env}.
Show the details of server {server} on environment {env}.
PUT /environments/{environmentId}/servers/{serverId} Change a server's memcache allocation · Modifies configuration settings for a server #
Ask an LLM
“Can I change how much memcache a server gets?”
“What adjusts the memcache setting on one server?”
Tell an agent
Set memcache on server {server} in environment {env} to {memcache}.
Change the memcache allocation of server {server} on environment {env} to {memcache}.
POST /environments/{environmentId}/servers/{serverId}/actions/reboot Reboot a server · Reboots a server #
Ask an LLM
“Can I reboot a stuck server, and will my apps go down while it restarts?”
“What restarts a single server in an environment?”
Tell an agent destructive · confirm first
Reboot server {server} in environment {env}.
Restart server {server} on environment {env}.
POST /environments/{environmentId}/servers/{serverId}/actions/relaunch Relaunch a server · Relaunches a server #
Ask an LLM
“How do I relaunch a server onto fresh infrastructure?”
“Will relaunching a server take my applications offline?”
Tell an agent destructive · confirm first
Relaunch server {server} in environment {env}.
Relaunch server {server} on environment {env} even though its apps will be briefly unavailable.
POST /environments/{environmentId}/servers/{serverId}/actions/suspend Suspend a server · Suspends a server #
Ask an LLM
“Can I suspend a server so it stops answering web requests?”
“What takes a server out of service without deleting it?”
Tell an agent destructive · confirm first
Suspend server {server} in environment {env}.
Stop server {server} on environment {env} from serving web requests.
POST /environments/{environmentId}/servers/{serverId}/actions/upgrade Upgrade a server's OS from precise to xenial · Upgrades a server from "precise" to "xenial" #
Ask an LLM
“Can I upgrade an old server from Ubuntu precise to xenial?”
“What moves a server onto the xenial operating system?”
Tell an agent
Upgrade server {server} in environment {env} from precise to xenial.
Move server {server} on environment {env} to xenial.
GET /environments/{environmentId}/settings Browse settings links for an environment · Provides links to environment settings #
Ask an LLM
“Which settings areas can I navigate to for an environment?”
“Where are the links to an environment's settings?”
Tell an agent
Show the settings links for environment {env}.
Open the settings index of environment {env}.
GET /environments/{environmentId}/ssl View SSL settings for an environment · Returns the SSL settings for this environment #
Ask an LLM
“How is SSL configured on this environment?”
“What are an environment's current SSL settings?”
Tell an agent
Show the SSL settings for environment {env}.
Get the SSL configuration of environment {env}.
GET /environments/{environmentId}/ssl/certificates List SSL certificates installed on an environment · Return a list of SSL certificates #
Ask an LLM
“Which SSL certificates are installed on my environment?”
“Can I see all the certificates, active and inactive, on an environment?”
Tell an agent
List the SSL certificates on environment {env}.
Show every installed certificate in environment {env}.
POST /environments/{environmentId}/ssl/certificates Install an SSL certificate · Install an SSL certificate #
Ask an LLM
“How do I upload my own SSL certificate and private key?”
“Can I include CA intermediate certificates when installing a cert?”
Tell an agent
Install SSL certificate {certificate} with private key {private_key} on environment {env}.
Add certificate {label} to environment {env} using cert {certificate}, key {private_key} and CA chain {ca_certificates}.
GET /environments/{environmentId}/ssl/certificates/{certificateId} View one SSL certificate · Returns a specific certificate by certificate id #
Ask an LLM
“When does a specific SSL certificate expire and which domains does it cover?”
“Can I look up one installed certificate by its ID?”
Tell an agent
Get SSL certificate {certificate} on environment {env}.
Show the details of installed certificate {certificate} in environment {env}.
DELETE /environments/{environmentId}/ssl/certificates/{certificateId} Delete an SSL certificate · Deletes a specific certificate by its ID #
Ask an LLM
“Can I remove an expired SSL certificate from an environment?”
“What deletes an installed certificate for good?”
Tell an agent destructive · confirm first
Delete SSL certificate {certificate} from environment {env}.
Remove installed certificate {certificate} on environment {env}.
POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate Activate an SSL certificate · Activates an SSL certificate #
Ask an LLM
“How do I make a newly installed certificate the active one?”
“Can I switch an environment over to a different SSL certificate?”
Tell an agent
Activate SSL certificate {certificate} on environment {env}.
Make certificate {certificate} live on environment {env}.
POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate Deactivate an SSL certificate · Deactivates an active SSL certificate #
Ask an LLM
“Can I stop serving a certificate without deleting it?”
“What deactivates the currently active SSL certificate?”
Tell an agent
Deactivate SSL certificate {certificate} on environment {env}.
Take certificate {certificate} out of service on environment {env} but keep it installed.
GET /environments/{environmentId}/ssl/csrs List certificate signing requests · Returns certificate signing requests #
Ask an LLM
“Which certificate signing requests have been generated for an environment?”
“Can I see all the CSRs I've created?”
Tell an agent
List the certificate signing requests on environment {env}.
Show every CSR generated for environment {env}.
POST /environments/{environmentId}/ssl/csrs Generate a certificate signing request · Generates a certificate signing request (CSR) for one or more domains #
Ask an LLM
“How do I generate a CSR to send to my certificate authority?”
“Can one CSR cover several domains through alternate names?”
Tell an agent
Generate a CSR on environment {env} for {common_name}, organization {organization}, unit {organizational_unit}, in {locality}, {state}, {country}.
Create a CSR for {common_name} plus {alternate_names} on environment {env} ({organization}, {organizational_unit}, {locality}, {state}, {country}).
GET /environments/{environmentId}/ssl/csrs/{certificateId} View one certificate signing request · Returns the certificate signing request for the certificate specified by id #
Ask an LLM
“What does a specific CSR contain?”
“Can I retrieve a CSR's text so I can submit it to a CA?”
Tell an agent
Get CSR {csr} on environment {env}.
Show the certificate signing request {csr} for environment {env}.
DELETE /environments/{environmentId}/ssl/csrs/{certificateId} Delete a certificate signing request · Deletes the certificate signing request #
Ask an LLM
“Can I delete a CSR I no longer need?”
“What removes an unused certificate signing request?”
Tell an agent destructive · confirm first
Delete CSR {csr} from environment {env}.
Remove certificate signing request {csr} on environment {env}.
GET /environments/{environmentId}/variables List environment variables · Returns a list of environment variables associated with this environment #
Ask an LLM
“Which environment variables are set on this environment?”
“Can I search an environment's variables by name?”
Tell an agent
List the environment variables on environment {env}.
Find variables on environment {env} named like {filter}.
POST /environments/{environmentId}/variables Add an environment variable · Adds a new environment variable to an environment #
Ask an LLM
“How do I add a new environment variable, like an API key, to an environment?”
“Can I define a brand-new variable for my app to read at runtime?”
Tell an agent
Add variable {name} with value {value} to environment {env}.
Create a new environment variable {name} = {value} on environment {env}.
GET /environments/{environmentId}/variables/{environmentVariableName} Read one environment variable · Get an environment variable associated with this environment #
Ask an LLM
“What value is a specific environment variable set to?”
“Does an environment have a variable with a given name?”
Tell an agent
Get variable {variable} on environment {env}.
Show the value of {variable} in environment {env}.
DELETE /environments/{environmentId}/variables/{environmentVariableName} Remove an environment variable · Removes an environment variable from an environment #
Ask an LLM
“Can I delete an environment variable I no longer use?”
“What removes a variable from an environment?”
Tell an agent destructive · confirm first
Delete variable {variable} from environment {env}.
Remove environment variable {variable} on environment {env}.
PUT /environments/{environmentId}/variables/{environmentVariableName} Change an existing environment variable · Updates an environment variable on an environment #
Ask an LLM
“Can I change the value of an environment variable that already exists?”
“What rotates a secret stored in an existing variable?”
Tell an agent
Update existing variable {variable} on environment {env} to name {name} and value {value}.
Change the value of {variable} in environment {env} to {value}, keeping name {name}.

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