naftiko: 1.0.0-alpha2 info: label: Acquia Cloud API Documentation — Environments description: 'Acquia Cloud API Documentation — Environments. 102 operations. Lead operation: Return details about a specific environment.. Self-contained Naftiko capability covering one Acquia business surface.' tags: - Acquia - Environments created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: ACQUIA_API_KEY: ACQUIA_API_KEY capability: consumes: - type: http namespace: cloud-openapi-full-environments baseUri: '' description: Acquia Cloud API Documentation — Environments business capability. Self-contained, no shared references. resources: - name: environments-environmentId path: /environments/{environmentId} operations: - name: getenvironment method: GET description: Return details about a specific environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putenvironment method: PUT description: Modifies configuration settings for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deleteenvironment method: DELETE description: Deletes a CD environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: optionsenvironment method: OPTIONS description: Displays environment options. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-actions-change-label path: /environments/{environmentId}/actions/change-label operations: - name: postchangeenvironmentlabel method: POST description: Change the label for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-actions-clear-caches path: /environments/{environmentId}/actions/clear-caches operations: - name: postenvironmentsclearcaches method: POST description: Clears the caches for one or more domains attached to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-artifacts-actions-switch path: /environments/{environmentId}/artifacts/actions/switch operations: - name: postdeployartifact method: POST description: Deploys an artifact to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-available-runtimes path: /environments/{environmentId}/available-runtimes operations: - name: getavailableruntimes method: GET description: Return a list of runtimes. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-cdn path: /environments/{environmentId}/cdn operations: - name: getcdnbyenvironmentid method: GET description: Returns the CDN status for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postcdnbyenvironmentid method: POST description: Enables a CDN for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletecdnbyenvironmentid method: DELETE description: Disables a CDN for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-cloud-actions path: /environments/{environmentId}/cloud-actions operations: - name: getenvironmentcloudactions method: GET description: Returns a list of Cloud Actions. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putenvironmentcloudactions method: PUT description: Modifies an existing list of Cloud Actions. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-cloud-actions-actions-disable path: /environments/{environmentId}/cloud-actions/actions/disable operations: - name: postenvironmentcloudactionsdisable method: POST description: Disables Cloud Actions. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-cloud-actions-actions-enable path: /environments/{environmentId}/cloud-actions/actions/enable operations: - name: postenvironmentcloudactionsenable method: POST description: Enables Cloud Actions. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-cloud-actions-actions-reset path: /environments/{environmentId}/cloud-actions/actions/reset operations: - name: postenvironmentcloudactionsreset method: POST description: Resets Cloud Actions. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-code path: /environments/{environmentId}/code operations: - name: postenvironmentsdeploycode method: POST description: Deploys code to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-code-actions-import path: /environments/{environmentId}/code/actions/import operations: - name: postenvironmentsimportsite method: POST description: Imports a site to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-code-actions-switch path: /environments/{environmentId}/code/actions/switch operations: - name: postenvironmentsswitchcode method: POST description: Switches code on this environment to a different branch or release tag. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-crons path: /environments/{environmentId}/crons operations: - name: getcronjobsbyenvironmentid method: GET description: Return environment cron jobs. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentcrons method: POST description: Creates a scheduled job with cron. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-crons-cronId path: /environments/{environmentId}/crons/{cronId} operations: - name: getcron method: GET description: Return details about a specific cron job. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putcron method: PUT description: Modify an existing scheduled job. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: postenvironmentcrondelete method: DELETE description: Deletes a cron job. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-crons-cronId-actions-disable path: /environments/{environmentId}/crons/{cronId}/actions/disable operations: - name: postenvironmentcrondisable method: POST description: Disables a cron job. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-crons-cronId-actions-enable path: /environments/{environmentId}/crons/{cronId}/actions/enable operations: - name: postenvironmentcronenable method: POST description: Enables a cron job. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-databases path: /environments/{environmentId}/databases operations: - name: getenvironmentsdatabases method: GET description: Returns a list of databases. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentsdatabases method: POST description: Copies a database to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-databases-databaseName path: /environments/{environmentId}/databases/{databaseName} operations: - name: getenvironmentsdatabase method: GET description: Return details about a specific database. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-databases-databaseName-backups path: /environments/{environmentId}/databases/{databaseName}/backups operations: - name: getenvironmentsdatabasebackups method: GET description: Returns a list of backups. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentsdatabasebackups method: POST description: Create a backup. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-databases-databaseName-backups-backupId path: /environments/{environmentId}/databases/{databaseName}/backups/{backupId} operations: - name: getenvironmentsdatabasebackup method: GET description: Return details about a specific backup. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteenvironmentsdatabasebackup method: DELETE description: Deletes a database backup. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-databases-databaseName-backups-backupId-actions-downl path: /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download operations: - name: getenvironmentsdatabasedownloadbackup method: GET description: Downloads the database backup file. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-databases-databaseName-backups-backupId-actions-resto path: /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore operations: - name: postenvironmentsdatabaserestorebackup method: POST description: Restores this backup to the appropriate environment's database. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-databases-databaseName-php-config path: /environments/{environmentId}/databases/{databaseName}/php-config operations: - name: getenvironmentsdatabasephpconfig method: GET description: Returns PHP configuration details for this database. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-dns path: /environments/{environmentId}/dns operations: - name: getenvironmentsdns method: GET description: Returns DNS configuration details for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-domains path: /environments/{environmentId}/domains operations: - name: getenvironmentsdomains method: GET description: Returns a list of domains. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentsdomains method: POST description: Adds a domain to the environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-domains-actions-clear-varnish path: /environments/{environmentId}/domains/actions/clear-varnish operations: - name: postenvironmentsdomainsclearvarnish method: POST description: Clears the Varnish cache for one or more domains attached to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-domains-domain path: /environments/{environmentId}/domains/{domain} operations: - name: getenvironmentsdomain method: GET description: Return details about a specific domain. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteenvironmentsdomain method: DELETE description: Removes the domain from this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-domains-domain-actions-clear-caches path: /environments/{environmentId}/domains/{domain}/actions/clear-caches operations: - name: postenvironmentsdomainclearcaches method: POST description: Clears the caches for the specified domain. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-domains-domain-actions-clear-varnish path: /environments/{environmentId}/domains/{domain}/actions/clear-varnish operations: - name: postenvironmentsdomainclearvarnish method: POST description: Clears the Varnish cache for the specified domain. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-domains-domain-status path: /environments/{environmentId}/domains/{domain}/status operations: - name: getenvironmentsdomainstatus method: GET description: Returns details about the domain. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-eips path: /environments/{environmentId}/eips operations: - name: geteips method: GET description: Return a list of Web EIPs. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-files path: /environments/{environmentId}/files operations: - name: postenvironmentsfiles method: POST description: Copies files to this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-livedev-actions-disable path: /environments/{environmentId}/livedev/actions/disable operations: - name: postenvironmentsdisablelivedev method: POST description: Disable Live Development on this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-livedev-actions-enable path: /environments/{environmentId}/livedev/actions/enable operations: - name: postenvironmentsenablelivedev method: POST description: Enable Live Development on this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-log-forwarding-destinations path: /environments/{environmentId}/log-forwarding-destinations operations: - name: getenvironmentslogforwardingdestinations method: GET description: Returns a collection of log forwarding destinations for this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentslogforwardingdestinations method: POST description: Creates a log forwarding destination. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-log-forwarding-destinations-logForwardingDestinationU path: /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid} operations: - name: getenvironmentslogforwardingdestination method: GET description: Returns the specified log forwarding destination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putenvironmentslogforwardingdestination method: PUT description: Updates an environment's log forwarding destination. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deleteenvironmentslogforwardingdestination method: DELETE description: Deletes the specified log forwarding destination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-log-forwarding-destinations-logForwardingDestinationU path: /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable operations: - name: postenvironmentsdisablelogforwardingdestination method: POST description: Disables the specified log forwarding destination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-log-forwarding-destinations-logForwardingDestinationU path: /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable operations: - name: postenvironmentsenablelogforwardingdestination method: POST description: Enables the specified log forwarding destination. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-logs path: /environments/{environmentId}/logs operations: - name: getenvironmentslogs method: GET description: Returns a list of log files for this environment available for download. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-logs-logType path: /environments/{environmentId}/logs/{logType} operations: - name: getenvironmentslog method: GET description: Downloads the log file. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentslog method: POST description: Creates a log file snapshot. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: environments-environmentId-logstream path: /environments/{environmentId}/logstream operations: - name: getenvironmentslogstream method: GET description: Returns a logstream url and metadata. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-metrics path: /environments/{environmentId}/metrics operations: - name: getenvironmentsmetrics method: GET description: Does not return any data. Allows traversal to metrics groups endpoints. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-metrics-stackmetrics path: /environments/{environmentId}/metrics/stackmetrics operations: - name: getenvironmentsstackmetrics method: GET description: Does not return any data. Allows traversal to StackMetrics endpoints. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-metrics-stackmetrics-data path: /environments/{environmentId}/metrics/stackmetrics/data operations: - name: getenvironmentsstackmetricsdata method: GET description: Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu). outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-metrics-usage path: /environments/{environmentId}/metrics/usage operations: - name: getenvironmentsusagelinks method: GET description: Retrieves traversal links for an environment's usage data. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-metrics-usage-data path: /environments/{environmentId}/metrics/usage/data operations: - name: getenvironmentsusagedata method: GET description: Retrieves usage data for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-metrics-usage-usageMetric path: /environments/{environmentId}/metrics/usage/{usageMetric} operations: - name: getenvironmentsusagemetricdata method: GET description: Retrieves usage metric data for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-mod-proxy path: /environments/{environmentId}/mod-proxy operations: - name: getmodproxystatus method: GET description: Returns the mod proxy status for an Environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-mod-proxy-actions-disable path: /environments/{environmentId}/mod-proxy/actions/disable operations: - name: postdisablemodproxy method: POST description: Disables mod proxy for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-mod-proxy-actions-enable path: /environments/{environmentId}/mod-proxy/actions/enable operations: - name: postenablemodproxy method: POST description: Enables mod proxy for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-operating-systems path: /environments/{environmentId}/operating-systems operations: - name: getoperatingsystems method: GET description: Return a list of operating systems. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-production-mode-actions-disable path: /environments/{environmentId}/production-mode/actions/disable operations: - name: postenvironmentsdisableproductionmode method: POST description: Disables production mode for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-production-mode-actions-enable path: /environments/{environmentId}/production-mode/actions/enable operations: - name: postenvironmentsenableproductionmode method: POST description: Enables production mode for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-search path: /environments/{environmentId}/search operations: - name: getenvironmentsearchlist method: GET description: Returns a traversal endpoint for search entities for the environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-search-indexes path: /environments/{environmentId}/search/indexes operations: - name: getenvironmentsearchindexes method: GET description: Returns a collection of search indexes for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentsearchindexes method: POST description: Creates a search index for an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-search-indexes-indexId path: /environments/{environmentId}/search/indexes/{indexId} operations: - name: getenvironmentsearchindex method: GET description: Returns a search configuration set for an application outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putenvironmentsearchindex method: PUT description: Updates a search index on an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deleteenvironmentsearchindex method: DELETE description: Removes and deletes a specific search index from an environment outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-servers path: /environments/{environmentId}/servers operations: - name: getenvironmentsservers method: GET description: Returns a list of servers. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-servers-serverId path: /environments/{environmentId}/servers/{serverId} operations: - name: getenvironmentsserver method: GET description: Return details about a specific server. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putenvironmentsserver method: PUT description: Modifies configuration settings for a server. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-servers-serverId-actions-reboot path: /environments/{environmentId}/servers/{serverId}/actions/reboot operations: - name: postenvironmentsserverreboot method: POST description: Reboots a server. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-servers-serverId-actions-relaunch path: /environments/{environmentId}/servers/{serverId}/actions/relaunch operations: - name: postenvironmentsserverrelaunch method: POST description: Relaunches a server. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-servers-serverId-actions-suspend path: /environments/{environmentId}/servers/{serverId}/actions/suspend operations: - name: postenvironmentsserversuspend method: POST description: Suspends a server. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-servers-serverId-actions-upgrade path: /environments/{environmentId}/servers/{serverId}/actions/upgrade operations: - name: postenvironmentsserverupgrade method: POST description: Upgrades a server from "precise" to "xenial". outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-settings path: /environments/{environmentId}/settings operations: - name: getenvironmentssettings method: GET description: Provides links to environment settings. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-ssl path: /environments/{environmentId}/ssl operations: - name: getssl method: GET description: Returns the SSL settings for this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-ssl-certificates path: /environments/{environmentId}/ssl/certificates operations: - name: getcertificates method: GET description: Return a list of SSL certificates. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postcertificate method: POST description: Install an SSL certificate. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-ssl-certificates-certificateId path: /environments/{environmentId}/ssl/certificates/{certificateId} operations: - name: getcertificate method: GET description: Returns a specific certificate by certificate id. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletecertificate method: DELETE description: Deletes a specific certificate by its ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-ssl-certificates-certificateId-actions-activate path: /environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate operations: - name: postactivatecertificate method: POST description: Activates an SSL certificate. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-ssl-certificates-certificateId-actions-deactivate path: /environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate operations: - name: postdeactivatecertificate method: POST description: Deactivates an active SSL certificate. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-ssl-csrs path: /environments/{environmentId}/ssl/csrs operations: - name: getcertificatesigningrequests method: GET description: Returns certificate signing requests. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postcertificatesigningrequest method: POST description: Generates a certificate signing request (CSR) for one or more domains. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-ssl-csrs-certificateId path: /environments/{environmentId}/ssl/csrs/{certificateId} operations: - name: getcertificatesigningrequest method: GET description: Returns the certificate signing request for the certificate specified by id. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletecertificatesigningrequest method: DELETE description: Deletes the certificate signing request. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-environmentId-variables path: /environments/{environmentId}/variables operations: - name: getenvironmentsvariables method: GET description: Returns a list of environment variables associated with this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: postenvironmentsvariables method: POST description: Adds a new environment variable to an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: environments-environmentId-variables-environmentVariableName path: /environments/{environmentId}/variables/{environmentVariableName} operations: - name: getenvironmentsvariable method: GET description: Get an environment variable associated with this environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteenvironmentsvariable method: DELETE description: Removes an environment variable from an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putenvironmentsvariable method: PUT description: Updates an environment variable on an environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true authentication: type: bearer token: '{{env.ACQUIA_API_KEY}}' exposes: - type: rest namespace: cloud-openapi-full-environments-rest port: 8080 description: REST adapter for Acquia Cloud API Documentation — Environments. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/environments/{environmentid} name: environments-environmentid description: REST surface for environments-environmentId. operations: - method: GET name: getenvironment description: Return details about a specific environment. call: cloud-openapi-full-environments.getenvironment outputParameters: - type: object mapping: $. - method: PUT name: putenvironment description: Modifies configuration settings for an environment. call: cloud-openapi-full-environments.putenvironment with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironment description: Deletes a CD environment. call: cloud-openapi-full-environments.deleteenvironment outputParameters: - type: object mapping: $. - method: OPTIONS name: optionsenvironment description: Displays environment options. call: cloud-openapi-full-environments.optionsenvironment outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/actions/change-label name: environments-environmentid-actions-change-label description: REST surface for environments-environmentId-actions-change-label. operations: - method: POST name: postchangeenvironmentlabel description: Change the label for an environment. call: cloud-openapi-full-environments.postchangeenvironmentlabel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/actions/clear-caches name: environments-environmentid-actions-clear-caches description: REST surface for environments-environmentId-actions-clear-caches. operations: - method: POST name: postenvironmentsclearcaches description: Clears the caches for one or more domains attached to this environment. call: cloud-openapi-full-environments.postenvironmentsclearcaches with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/artifacts/actions/switch name: environments-environmentid-artifacts-actions-switch description: REST surface for environments-environmentId-artifacts-actions-switch. operations: - method: POST name: postdeployartifact description: Deploys an artifact to this environment. call: cloud-openapi-full-environments.postdeployartifact with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/available-runtimes name: environments-environmentid-available-runtimes description: REST surface for environments-environmentId-available-runtimes. operations: - method: GET name: getavailableruntimes description: Return a list of runtimes. call: cloud-openapi-full-environments.getavailableruntimes outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/cdn name: environments-environmentid-cdn description: REST surface for environments-environmentId-cdn. operations: - method: GET name: getcdnbyenvironmentid description: Returns the CDN status for an environment. call: cloud-openapi-full-environments.getcdnbyenvironmentid outputParameters: - type: object mapping: $. - method: POST name: postcdnbyenvironmentid description: Enables a CDN for an environment. call: cloud-openapi-full-environments.postcdnbyenvironmentid outputParameters: - type: object mapping: $. - method: DELETE name: deletecdnbyenvironmentid description: Disables a CDN for an environment. call: cloud-openapi-full-environments.deletecdnbyenvironmentid outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/cloud-actions name: environments-environmentid-cloud-actions description: REST surface for environments-environmentId-cloud-actions. operations: - method: GET name: getenvironmentcloudactions description: Returns a list of Cloud Actions. call: cloud-openapi-full-environments.getenvironmentcloudactions outputParameters: - type: object mapping: $. - method: PUT name: putenvironmentcloudactions description: Modifies an existing list of Cloud Actions. call: cloud-openapi-full-environments.putenvironmentcloudactions with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/cloud-actions/actions/disable name: environments-environmentid-cloud-actions-actions-disable description: REST surface for environments-environmentId-cloud-actions-actions-disable. operations: - method: POST name: postenvironmentcloudactionsdisable description: Disables Cloud Actions. call: cloud-openapi-full-environments.postenvironmentcloudactionsdisable outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/cloud-actions/actions/enable name: environments-environmentid-cloud-actions-actions-enable description: REST surface for environments-environmentId-cloud-actions-actions-enable. operations: - method: POST name: postenvironmentcloudactionsenable description: Enables Cloud Actions. call: cloud-openapi-full-environments.postenvironmentcloudactionsenable outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/cloud-actions/actions/reset name: environments-environmentid-cloud-actions-actions-reset description: REST surface for environments-environmentId-cloud-actions-actions-reset. operations: - method: POST name: postenvironmentcloudactionsreset description: Resets Cloud Actions. call: cloud-openapi-full-environments.postenvironmentcloudactionsreset outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/code name: environments-environmentid-code description: REST surface for environments-environmentId-code. operations: - method: POST name: postenvironmentsdeploycode description: Deploys code to this environment. call: cloud-openapi-full-environments.postenvironmentsdeploycode with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/code/actions/import name: environments-environmentid-code-actions-import description: REST surface for environments-environmentId-code-actions-import. operations: - method: POST name: postenvironmentsimportsite description: Imports a site to this environment. call: cloud-openapi-full-environments.postenvironmentsimportsite with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/code/actions/switch name: environments-environmentid-code-actions-switch description: REST surface for environments-environmentId-code-actions-switch. operations: - method: POST name: postenvironmentsswitchcode description: Switches code on this environment to a different branch or release tag. call: cloud-openapi-full-environments.postenvironmentsswitchcode with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/crons name: environments-environmentid-crons description: REST surface for environments-environmentId-crons. operations: - method: GET name: getcronjobsbyenvironmentid description: Return environment cron jobs. call: cloud-openapi-full-environments.getcronjobsbyenvironmentid outputParameters: - type: object mapping: $. - method: POST name: postenvironmentcrons description: Creates a scheduled job with cron. call: cloud-openapi-full-environments.postenvironmentcrons with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/crons/{cronid} name: environments-environmentid-crons-cronid description: REST surface for environments-environmentId-crons-cronId. operations: - method: GET name: getcron description: Return details about a specific cron job. call: cloud-openapi-full-environments.getcron outputParameters: - type: object mapping: $. - method: PUT name: putcron description: Modify an existing scheduled job. call: cloud-openapi-full-environments.putcron with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: postenvironmentcrondelete description: Deletes a cron job. call: cloud-openapi-full-environments.postenvironmentcrondelete outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/crons/{cronid}/actions/disable name: environments-environmentid-crons-cronid-actions-disable description: REST surface for environments-environmentId-crons-cronId-actions-disable. operations: - method: POST name: postenvironmentcrondisable description: Disables a cron job. call: cloud-openapi-full-environments.postenvironmentcrondisable outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/crons/{cronid}/actions/enable name: environments-environmentid-crons-cronid-actions-enable description: REST surface for environments-environmentId-crons-cronId-actions-enable. operations: - method: POST name: postenvironmentcronenable description: Enables a cron job. call: cloud-openapi-full-environments.postenvironmentcronenable outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases name: environments-environmentid-databases description: REST surface for environments-environmentId-databases. operations: - method: GET name: getenvironmentsdatabases description: Returns a list of databases. call: cloud-openapi-full-environments.getenvironmentsdatabases outputParameters: - type: object mapping: $. - method: POST name: postenvironmentsdatabases description: Copies a database to this environment. call: cloud-openapi-full-environments.postenvironmentsdatabases with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases/{databasename} name: environments-environmentid-databases-databasename description: REST surface for environments-environmentId-databases-databaseName. operations: - method: GET name: getenvironmentsdatabase description: Return details about a specific database. call: cloud-openapi-full-environments.getenvironmentsdatabase outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases/{databasename}/backups name: environments-environmentid-databases-databasename-backups description: REST surface for environments-environmentId-databases-databaseName-backups. operations: - method: GET name: getenvironmentsdatabasebackups description: Returns a list of backups. call: cloud-openapi-full-environments.getenvironmentsdatabasebackups outputParameters: - type: object mapping: $. - method: POST name: postenvironmentsdatabasebackups description: Create a backup. call: cloud-openapi-full-environments.postenvironmentsdatabasebackups outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases/{databasename}/backups/{backupid} name: environments-environmentid-databases-databasename-backups-backupid description: REST surface for environments-environmentId-databases-databaseName-backups-backupId. operations: - method: GET name: getenvironmentsdatabasebackup description: Return details about a specific backup. call: cloud-openapi-full-environments.getenvironmentsdatabasebackup outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironmentsdatabasebackup description: Deletes a database backup. call: cloud-openapi-full-environments.deleteenvironmentsdatabasebackup outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases/{databasename}/backups/{backupid}/actions/download name: environments-environmentid-databases-databasename-backups-backupid-actions-downl description: REST surface for environments-environmentId-databases-databaseName-backups-backupId-actions-downl. operations: - method: GET name: getenvironmentsdatabasedownloadbackup description: Downloads the database backup file. call: cloud-openapi-full-environments.getenvironmentsdatabasedownloadbackup outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases/{databasename}/backups/{backupid}/actions/restore name: environments-environmentid-databases-databasename-backups-backupid-actions-resto description: REST surface for environments-environmentId-databases-databaseName-backups-backupId-actions-resto. operations: - method: POST name: postenvironmentsdatabaserestorebackup description: Restores this backup to the appropriate environment's database. call: cloud-openapi-full-environments.postenvironmentsdatabaserestorebackup outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/databases/{databasename}/php-config name: environments-environmentid-databases-databasename-php-config description: REST surface for environments-environmentId-databases-databaseName-php-config. operations: - method: GET name: getenvironmentsdatabasephpconfig description: Returns PHP configuration details for this database. call: cloud-openapi-full-environments.getenvironmentsdatabasephpconfig outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/dns name: environments-environmentid-dns description: REST surface for environments-environmentId-dns. operations: - method: GET name: getenvironmentsdns description: Returns DNS configuration details for an environment. call: cloud-openapi-full-environments.getenvironmentsdns outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/domains name: environments-environmentid-domains description: REST surface for environments-environmentId-domains. operations: - method: GET name: getenvironmentsdomains description: Returns a list of domains. call: cloud-openapi-full-environments.getenvironmentsdomains outputParameters: - type: object mapping: $. - method: POST name: postenvironmentsdomains description: Adds a domain to the environment. call: cloud-openapi-full-environments.postenvironmentsdomains with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/domains/actions/clear-varnish name: environments-environmentid-domains-actions-clear-varnish description: REST surface for environments-environmentId-domains-actions-clear-varnish. operations: - method: POST name: postenvironmentsdomainsclearvarnish description: Clears the Varnish cache for one or more domains attached to this environment. call: cloud-openapi-full-environments.postenvironmentsdomainsclearvarnish with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/domains/{domain} name: environments-environmentid-domains-domain description: REST surface for environments-environmentId-domains-domain. operations: - method: GET name: getenvironmentsdomain description: Return details about a specific domain. call: cloud-openapi-full-environments.getenvironmentsdomain outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironmentsdomain description: Removes the domain from this environment. call: cloud-openapi-full-environments.deleteenvironmentsdomain outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/domains/{domain}/actions/clear-caches name: environments-environmentid-domains-domain-actions-clear-caches description: REST surface for environments-environmentId-domains-domain-actions-clear-caches. operations: - method: POST name: postenvironmentsdomainclearcaches description: Clears the caches for the specified domain. call: cloud-openapi-full-environments.postenvironmentsdomainclearcaches outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/domains/{domain}/actions/clear-varnish name: environments-environmentid-domains-domain-actions-clear-varnish description: REST surface for environments-environmentId-domains-domain-actions-clear-varnish. operations: - method: POST name: postenvironmentsdomainclearvarnish description: Clears the Varnish cache for the specified domain. call: cloud-openapi-full-environments.postenvironmentsdomainclearvarnish outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/domains/{domain}/status name: environments-environmentid-domains-domain-status description: REST surface for environments-environmentId-domains-domain-status. operations: - method: GET name: getenvironmentsdomainstatus description: Returns details about the domain. call: cloud-openapi-full-environments.getenvironmentsdomainstatus outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/eips name: environments-environmentid-eips description: REST surface for environments-environmentId-eips. operations: - method: GET name: geteips description: Return a list of Web EIPs. call: cloud-openapi-full-environments.geteips outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/files name: environments-environmentid-files description: REST surface for environments-environmentId-files. operations: - method: POST name: postenvironmentsfiles description: Copies files to this environment. call: cloud-openapi-full-environments.postenvironmentsfiles with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/livedev/actions/disable name: environments-environmentid-livedev-actions-disable description: REST surface for environments-environmentId-livedev-actions-disable. operations: - method: POST name: postenvironmentsdisablelivedev description: Disable Live Development on this environment. call: cloud-openapi-full-environments.postenvironmentsdisablelivedev with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/livedev/actions/enable name: environments-environmentid-livedev-actions-enable description: REST surface for environments-environmentId-livedev-actions-enable. operations: - method: POST name: postenvironmentsenablelivedev description: Enable Live Development on this environment. call: cloud-openapi-full-environments.postenvironmentsenablelivedev outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/log-forwarding-destinations name: environments-environmentid-log-forwarding-destinations description: REST surface for environments-environmentId-log-forwarding-destinations. operations: - method: GET name: getenvironmentslogforwardingdestinations description: Returns a collection of log forwarding destinations for this environment. call: cloud-openapi-full-environments.getenvironmentslogforwardingdestinations outputParameters: - type: object mapping: $. - method: POST name: postenvironmentslogforwardingdestinations description: Creates a log forwarding destination. call: cloud-openapi-full-environments.postenvironmentslogforwardingdestinations with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/log-forwarding-destinations/{logforwardingdestinationuuid} name: environments-environmentid-log-forwarding-destinations-logforwardingdestinationu description: REST surface for environments-environmentId-log-forwarding-destinations-logForwardingDestinationU. operations: - method: GET name: getenvironmentslogforwardingdestination description: Returns the specified log forwarding destination. call: cloud-openapi-full-environments.getenvironmentslogforwardingdestination outputParameters: - type: object mapping: $. - method: PUT name: putenvironmentslogforwardingdestination description: Updates an environment's log forwarding destination. call: cloud-openapi-full-environments.putenvironmentslogforwardingdestination with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironmentslogforwardingdestination description: Deletes the specified log forwarding destination. call: cloud-openapi-full-environments.deleteenvironmentslogforwardingdestination outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/log-forwarding-destinations/{logforwardingdestinationuuid}/actions/disable name: environments-environmentid-log-forwarding-destinations-logforwardingdestinationu description: REST surface for environments-environmentId-log-forwarding-destinations-logForwardingDestinationU. operations: - method: POST name: postenvironmentsdisablelogforwardingdestination description: Disables the specified log forwarding destination. call: cloud-openapi-full-environments.postenvironmentsdisablelogforwardingdestination outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/log-forwarding-destinations/{logforwardingdestinationuuid}/actions/enable name: environments-environmentid-log-forwarding-destinations-logforwardingdestinationu description: REST surface for environments-environmentId-log-forwarding-destinations-logForwardingDestinationU. operations: - method: POST name: postenvironmentsenablelogforwardingdestination description: Enables the specified log forwarding destination. call: cloud-openapi-full-environments.postenvironmentsenablelogforwardingdestination outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/logs name: environments-environmentid-logs description: REST surface for environments-environmentId-logs. operations: - method: GET name: getenvironmentslogs description: Returns a list of log files for this environment available for download. call: cloud-openapi-full-environments.getenvironmentslogs outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/logs/{logtype} name: environments-environmentid-logs-logtype description: REST surface for environments-environmentId-logs-logType. operations: - method: GET name: getenvironmentslog description: Downloads the log file. call: cloud-openapi-full-environments.getenvironmentslog outputParameters: - type: object mapping: $. - method: POST name: postenvironmentslog description: Creates a log file snapshot. call: cloud-openapi-full-environments.postenvironmentslog with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/logstream name: environments-environmentid-logstream description: REST surface for environments-environmentId-logstream. operations: - method: GET name: getenvironmentslogstream description: Returns a logstream url and metadata. call: cloud-openapi-full-environments.getenvironmentslogstream outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/metrics name: environments-environmentid-metrics description: REST surface for environments-environmentId-metrics. operations: - method: GET name: getenvironmentsmetrics description: Does not return any data. Allows traversal to metrics groups endpoints. call: cloud-openapi-full-environments.getenvironmentsmetrics outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/metrics/stackmetrics name: environments-environmentid-metrics-stackmetrics description: REST surface for environments-environmentId-metrics-stackmetrics. operations: - method: GET name: getenvironmentsstackmetrics description: Does not return any data. Allows traversal to StackMetrics endpoints. call: cloud-openapi-full-environments.getenvironmentsstackmetrics outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/metrics/stackmetrics/data name: environments-environmentid-metrics-stackmetrics-data description: REST surface for environments-environmentId-metrics-stackmetrics-data. operations: - method: GET name: getenvironmentsstackmetricsdata description: Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu). call: cloud-openapi-full-environments.getenvironmentsstackmetricsdata outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/metrics/usage name: environments-environmentid-metrics-usage description: REST surface for environments-environmentId-metrics-usage. operations: - method: GET name: getenvironmentsusagelinks description: Retrieves traversal links for an environment's usage data. call: cloud-openapi-full-environments.getenvironmentsusagelinks outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/metrics/usage/data name: environments-environmentid-metrics-usage-data description: REST surface for environments-environmentId-metrics-usage-data. operations: - method: GET name: getenvironmentsusagedata description: Retrieves usage data for an environment. call: cloud-openapi-full-environments.getenvironmentsusagedata outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/metrics/usage/{usagemetric} name: environments-environmentid-metrics-usage-usagemetric description: REST surface for environments-environmentId-metrics-usage-usageMetric. operations: - method: GET name: getenvironmentsusagemetricdata description: Retrieves usage metric data for an environment. call: cloud-openapi-full-environments.getenvironmentsusagemetricdata outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/mod-proxy name: environments-environmentid-mod-proxy description: REST surface for environments-environmentId-mod-proxy. operations: - method: GET name: getmodproxystatus description: Returns the mod proxy status for an Environment. call: cloud-openapi-full-environments.getmodproxystatus outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/mod-proxy/actions/disable name: environments-environmentid-mod-proxy-actions-disable description: REST surface for environments-environmentId-mod-proxy-actions-disable. operations: - method: POST name: postdisablemodproxy description: Disables mod proxy for an environment. call: cloud-openapi-full-environments.postdisablemodproxy outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/mod-proxy/actions/enable name: environments-environmentid-mod-proxy-actions-enable description: REST surface for environments-environmentId-mod-proxy-actions-enable. operations: - method: POST name: postenablemodproxy description: Enables mod proxy for an environment. call: cloud-openapi-full-environments.postenablemodproxy outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/operating-systems name: environments-environmentid-operating-systems description: REST surface for environments-environmentId-operating-systems. operations: - method: GET name: getoperatingsystems description: Return a list of operating systems. call: cloud-openapi-full-environments.getoperatingsystems outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/production-mode/actions/disable name: environments-environmentid-production-mode-actions-disable description: REST surface for environments-environmentId-production-mode-actions-disable. operations: - method: POST name: postenvironmentsdisableproductionmode description: Disables production mode for an environment. call: cloud-openapi-full-environments.postenvironmentsdisableproductionmode outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/production-mode/actions/enable name: environments-environmentid-production-mode-actions-enable description: REST surface for environments-environmentId-production-mode-actions-enable. operations: - method: POST name: postenvironmentsenableproductionmode description: Enables production mode for an environment. call: cloud-openapi-full-environments.postenvironmentsenableproductionmode outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/search name: environments-environmentid-search description: REST surface for environments-environmentId-search. operations: - method: GET name: getenvironmentsearchlist description: Returns a traversal endpoint for search entities for the environment. call: cloud-openapi-full-environments.getenvironmentsearchlist outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/search/indexes name: environments-environmentid-search-indexes description: REST surface for environments-environmentId-search-indexes. operations: - method: GET name: getenvironmentsearchindexes description: Returns a collection of search indexes for an environment. call: cloud-openapi-full-environments.getenvironmentsearchindexes outputParameters: - type: object mapping: $. - method: POST name: postenvironmentsearchindexes description: Creates a search index for an environment. call: cloud-openapi-full-environments.postenvironmentsearchindexes with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/search/indexes/{indexid} name: environments-environmentid-search-indexes-indexid description: REST surface for environments-environmentId-search-indexes-indexId. operations: - method: GET name: getenvironmentsearchindex description: Returns a search configuration set for an application call: cloud-openapi-full-environments.getenvironmentsearchindex outputParameters: - type: object mapping: $. - method: PUT name: putenvironmentsearchindex description: Updates a search index on an environment. call: cloud-openapi-full-environments.putenvironmentsearchindex with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironmentsearchindex description: Removes and deletes a specific search index from an environment call: cloud-openapi-full-environments.deleteenvironmentsearchindex outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/servers name: environments-environmentid-servers description: REST surface for environments-environmentId-servers. operations: - method: GET name: getenvironmentsservers description: Returns a list of servers. call: cloud-openapi-full-environments.getenvironmentsservers outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/servers/{serverid} name: environments-environmentid-servers-serverid description: REST surface for environments-environmentId-servers-serverId. operations: - method: GET name: getenvironmentsserver description: Return details about a specific server. call: cloud-openapi-full-environments.getenvironmentsserver outputParameters: - type: object mapping: $. - method: PUT name: putenvironmentsserver description: Modifies configuration settings for a server. call: cloud-openapi-full-environments.putenvironmentsserver with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/servers/{serverid}/actions/reboot name: environments-environmentid-servers-serverid-actions-reboot description: REST surface for environments-environmentId-servers-serverId-actions-reboot. operations: - method: POST name: postenvironmentsserverreboot description: Reboots a server. call: cloud-openapi-full-environments.postenvironmentsserverreboot outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/servers/{serverid}/actions/relaunch name: environments-environmentid-servers-serverid-actions-relaunch description: REST surface for environments-environmentId-servers-serverId-actions-relaunch. operations: - method: POST name: postenvironmentsserverrelaunch description: Relaunches a server. call: cloud-openapi-full-environments.postenvironmentsserverrelaunch outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/servers/{serverid}/actions/suspend name: environments-environmentid-servers-serverid-actions-suspend description: REST surface for environments-environmentId-servers-serverId-actions-suspend. operations: - method: POST name: postenvironmentsserversuspend description: Suspends a server. call: cloud-openapi-full-environments.postenvironmentsserversuspend outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/servers/{serverid}/actions/upgrade name: environments-environmentid-servers-serverid-actions-upgrade description: REST surface for environments-environmentId-servers-serverId-actions-upgrade. operations: - method: POST name: postenvironmentsserverupgrade description: Upgrades a server from "precise" to "xenial". call: cloud-openapi-full-environments.postenvironmentsserverupgrade outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/settings name: environments-environmentid-settings description: REST surface for environments-environmentId-settings. operations: - method: GET name: getenvironmentssettings description: Provides links to environment settings. call: cloud-openapi-full-environments.getenvironmentssettings outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl name: environments-environmentid-ssl description: REST surface for environments-environmentId-ssl. operations: - method: GET name: getssl description: Returns the SSL settings for this environment. call: cloud-openapi-full-environments.getssl outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl/certificates name: environments-environmentid-ssl-certificates description: REST surface for environments-environmentId-ssl-certificates. operations: - method: GET name: getcertificates description: Return a list of SSL certificates. call: cloud-openapi-full-environments.getcertificates outputParameters: - type: object mapping: $. - method: POST name: postcertificate description: Install an SSL certificate. call: cloud-openapi-full-environments.postcertificate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl/certificates/{certificateid} name: environments-environmentid-ssl-certificates-certificateid description: REST surface for environments-environmentId-ssl-certificates-certificateId. operations: - method: GET name: getcertificate description: Returns a specific certificate by certificate id. call: cloud-openapi-full-environments.getcertificate outputParameters: - type: object mapping: $. - method: DELETE name: deletecertificate description: Deletes a specific certificate by its ID. call: cloud-openapi-full-environments.deletecertificate outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl/certificates/{certificateid}/actions/activate name: environments-environmentid-ssl-certificates-certificateid-actions-activate description: REST surface for environments-environmentId-ssl-certificates-certificateId-actions-activate. operations: - method: POST name: postactivatecertificate description: Activates an SSL certificate. call: cloud-openapi-full-environments.postactivatecertificate outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl/certificates/{certificateid}/actions/deactivate name: environments-environmentid-ssl-certificates-certificateid-actions-deactivate description: REST surface for environments-environmentId-ssl-certificates-certificateId-actions-deactivate. operations: - method: POST name: postdeactivatecertificate description: Deactivates an active SSL certificate. call: cloud-openapi-full-environments.postdeactivatecertificate outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl/csrs name: environments-environmentid-ssl-csrs description: REST surface for environments-environmentId-ssl-csrs. operations: - method: GET name: getcertificatesigningrequests description: Returns certificate signing requests. call: cloud-openapi-full-environments.getcertificatesigningrequests outputParameters: - type: object mapping: $. - method: POST name: postcertificatesigningrequest description: Generates a certificate signing request (CSR) for one or more domains. call: cloud-openapi-full-environments.postcertificatesigningrequest with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/ssl/csrs/{certificateid} name: environments-environmentid-ssl-csrs-certificateid description: REST surface for environments-environmentId-ssl-csrs-certificateId. operations: - method: GET name: getcertificatesigningrequest description: Returns the certificate signing request for the certificate specified by id. call: cloud-openapi-full-environments.getcertificatesigningrequest outputParameters: - type: object mapping: $. - method: DELETE name: deletecertificatesigningrequest description: Deletes the certificate signing request. call: cloud-openapi-full-environments.deletecertificatesigningrequest outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/variables name: environments-environmentid-variables description: REST surface for environments-environmentId-variables. operations: - method: GET name: getenvironmentsvariables description: Returns a list of environment variables associated with this environment. call: cloud-openapi-full-environments.getenvironmentsvariables outputParameters: - type: object mapping: $. - method: POST name: postenvironmentsvariables description: Adds a new environment variable to an environment. call: cloud-openapi-full-environments.postenvironmentsvariables with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/environments/{environmentid}/variables/{environmentvariablename} name: environments-environmentid-variables-environmentvariablename description: REST surface for environments-environmentId-variables-environmentVariableName. operations: - method: GET name: getenvironmentsvariable description: Get an environment variable associated with this environment. call: cloud-openapi-full-environments.getenvironmentsvariable outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironmentsvariable description: Removes an environment variable from an environment. call: cloud-openapi-full-environments.deleteenvironmentsvariable outputParameters: - type: object mapping: $. - method: PUT name: putenvironmentsvariable description: Updates an environment variable on an environment. call: cloud-openapi-full-environments.putenvironmentsvariable with: body: rest.body outputParameters: - type: object mapping: $. - type: mcp namespace: cloud-openapi-full-environments-mcp port: 9090 transport: http description: MCP adapter for Acquia Cloud API Documentation — Environments. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: return-details-about-specific-environment description: Return details about a specific environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironment outputParameters: - type: object mapping: $. - name: modifies-configuration-settings-environment description: Modifies configuration settings for an environment. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putenvironment with: body: tools.body outputParameters: - type: object mapping: $. - name: deletes-cd-environment description: Deletes a CD environment. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deleteenvironment outputParameters: - type: object mapping: $. - name: displays-environment-options description: Displays environment options. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.optionsenvironment outputParameters: - type: object mapping: $. - name: change-label-environment description: Change the label for an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postchangeenvironmentlabel with: body: tools.body outputParameters: - type: object mapping: $. - name: clears-caches-one-more-domains description: Clears the caches for one or more domains attached to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsclearcaches with: body: tools.body outputParameters: - type: object mapping: $. - name: deploys-artifact-this-environment description: Deploys an artifact to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postdeployartifact with: body: tools.body outputParameters: - type: object mapping: $. - name: return-list-runtimes description: Return a list of runtimes. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getavailableruntimes outputParameters: - type: object mapping: $. - name: returns-cdn-status-environment description: Returns the CDN status for an environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcdnbyenvironmentid outputParameters: - type: object mapping: $. - name: enables-cdn-environment description: Enables a CDN for an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postcdnbyenvironmentid outputParameters: - type: object mapping: $. - name: disables-cdn-environment description: Disables a CDN for an environment. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deletecdnbyenvironmentid outputParameters: - type: object mapping: $. - name: returns-list-cloud-actions description: Returns a list of Cloud Actions. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentcloudactions outputParameters: - type: object mapping: $. - name: modifies-existing-list-cloud-actions description: Modifies an existing list of Cloud Actions. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putenvironmentcloudactions with: body: tools.body outputParameters: - type: object mapping: $. - name: disables-cloud-actions description: Disables Cloud Actions. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentcloudactionsdisable outputParameters: - type: object mapping: $. - name: enables-cloud-actions description: Enables Cloud Actions. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentcloudactionsenable outputParameters: - type: object mapping: $. - name: resets-cloud-actions description: Resets Cloud Actions. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentcloudactionsreset outputParameters: - type: object mapping: $. - name: deploys-code-this-environment description: Deploys code to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdeploycode with: body: tools.body outputParameters: - type: object mapping: $. - name: imports-site-this-environment description: Imports a site to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsimportsite with: body: tools.body outputParameters: - type: object mapping: $. - name: switches-code-this-environment-different description: Switches code on this environment to a different branch or release tag. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsswitchcode with: body: tools.body outputParameters: - type: object mapping: $. - name: return-environment-cron-jobs description: Return environment cron jobs. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcronjobsbyenvironmentid outputParameters: - type: object mapping: $. - name: creates-scheduled-job-cron description: Creates a scheduled job with cron. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentcrons with: body: tools.body outputParameters: - type: object mapping: $. - name: return-details-about-specific-cron description: Return details about a specific cron job. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcron outputParameters: - type: object mapping: $. - name: modify-existing-scheduled-job description: Modify an existing scheduled job. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putcron with: body: tools.body outputParameters: - type: object mapping: $. - name: deletes-cron-job description: Deletes a cron job. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.postenvironmentcrondelete outputParameters: - type: object mapping: $. - name: disables-cron-job description: Disables a cron job. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentcrondisable outputParameters: - type: object mapping: $. - name: enables-cron-job description: Enables a cron job. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentcronenable outputParameters: - type: object mapping: $. - name: returns-list-databases description: Returns a list of databases. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdatabases outputParameters: - type: object mapping: $. - name: copies-database-this-environment description: Copies a database to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdatabases with: body: tools.body outputParameters: - type: object mapping: $. - name: return-details-about-specific-database description: Return details about a specific database. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdatabase outputParameters: - type: object mapping: $. - name: returns-list-backups description: Returns a list of backups. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdatabasebackups outputParameters: - type: object mapping: $. - name: create-backup description: Create a backup. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdatabasebackups outputParameters: - type: object mapping: $. - name: return-details-about-specific-backup description: Return details about a specific backup. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdatabasebackup outputParameters: - type: object mapping: $. - name: deletes-database-backup description: Deletes a database backup. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deleteenvironmentsdatabasebackup outputParameters: - type: object mapping: $. - name: downloads-database-backup-file description: Downloads the database backup file. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdatabasedownloadbackup outputParameters: - type: object mapping: $. - name: restores-this-backup-appropriate-environment-s description: Restores this backup to the appropriate environment's database. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdatabaserestorebackup outputParameters: - type: object mapping: $. - name: returns-php-configuration-details-this description: Returns PHP configuration details for this database. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdatabasephpconfig outputParameters: - type: object mapping: $. - name: returns-dns-configuration-details-environment description: Returns DNS configuration details for an environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdns outputParameters: - type: object mapping: $. - name: returns-list-domains description: Returns a list of domains. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdomains outputParameters: - type: object mapping: $. - name: adds-domain-environment description: Adds a domain to the environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdomains with: body: tools.body outputParameters: - type: object mapping: $. - name: clears-varnish-cache-one-more description: Clears the Varnish cache for one or more domains attached to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdomainsclearvarnish with: body: tools.body outputParameters: - type: object mapping: $. - name: return-details-about-specific-domain description: Return details about a specific domain. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdomain outputParameters: - type: object mapping: $. - name: removes-domain-this-environment description: Removes the domain from this environment. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deleteenvironmentsdomain outputParameters: - type: object mapping: $. - name: clears-caches-specified-domain description: Clears the caches for the specified domain. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdomainclearcaches outputParameters: - type: object mapping: $. - name: clears-varnish-cache-specified-domain description: Clears the Varnish cache for the specified domain. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdomainclearvarnish outputParameters: - type: object mapping: $. - name: returns-details-about-domain description: Returns details about the domain. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsdomainstatus outputParameters: - type: object mapping: $. - name: return-list-web-eips description: Return a list of Web EIPs. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.geteips outputParameters: - type: object mapping: $. - name: copies-files-this-environment description: Copies files to this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsfiles with: body: tools.body outputParameters: - type: object mapping: $. - name: disable-live-development-this-environment description: Disable Live Development on this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdisablelivedev with: body: tools.body outputParameters: - type: object mapping: $. - name: enable-live-development-this-environment description: Enable Live Development on this environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsenablelivedev outputParameters: - type: object mapping: $. - name: returns-collection-log-forwarding-destinations description: Returns a collection of log forwarding destinations for this environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentslogforwardingdestinations outputParameters: - type: object mapping: $. - name: creates-log-forwarding-destination description: Creates a log forwarding destination. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentslogforwardingdestinations with: body: tools.body outputParameters: - type: object mapping: $. - name: returns-specified-log-forwarding-destination description: Returns the specified log forwarding destination. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentslogforwardingdestination outputParameters: - type: object mapping: $. - name: updates-environment-s-log-forwarding-destination description: Updates an environment's log forwarding destination. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putenvironmentslogforwardingdestination with: body: tools.body outputParameters: - type: object mapping: $. - name: deletes-specified-log-forwarding-destination description: Deletes the specified log forwarding destination. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deleteenvironmentslogforwardingdestination outputParameters: - type: object mapping: $. - name: disables-specified-log-forwarding-destination description: Disables the specified log forwarding destination. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdisablelogforwardingdestination outputParameters: - type: object mapping: $. - name: enables-specified-log-forwarding-destination description: Enables the specified log forwarding destination. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsenablelogforwardingdestination outputParameters: - type: object mapping: $. - name: returns-list-log-files-this description: Returns a list of log files for this environment available for download. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentslogs outputParameters: - type: object mapping: $. - name: downloads-log-file description: Downloads the log file. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentslog outputParameters: - type: object mapping: $. - name: creates-log-file-snapshot description: Creates a log file snapshot. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentslog with: body: tools.body outputParameters: - type: object mapping: $. - name: returns-logstream-url-and-metadata description: Returns a logstream url and metadata. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentslogstream outputParameters: - type: object mapping: $. - name: does-not-return-any-data description: Does not return any data. Allows traversal to metrics groups endpoints. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsmetrics outputParameters: - type: object mapping: $. - name: does-not-return-any-data-2 description: Does not return any data. Allows traversal to StackMetrics endpoints. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsstackmetrics outputParameters: - type: object mapping: $. - name: returns-stackmetrics-data-metrics-specified description: Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu). hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsstackmetricsdata outputParameters: - type: object mapping: $. - name: retrieves-traversal-links-environment-s-usage description: Retrieves traversal links for an environment's usage data. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsusagelinks outputParameters: - type: object mapping: $. - name: retrieves-usage-data-environment description: Retrieves usage data for an environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsusagedata outputParameters: - type: object mapping: $. - name: retrieves-usage-metric-data-environment description: Retrieves usage metric data for an environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsusagemetricdata outputParameters: - type: object mapping: $. - name: returns-mod-proxy-status-environment description: Returns the mod proxy status for an Environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getmodproxystatus outputParameters: - type: object mapping: $. - name: disables-mod-proxy-environment description: Disables mod proxy for an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postdisablemodproxy outputParameters: - type: object mapping: $. - name: enables-mod-proxy-environment description: Enables mod proxy for an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenablemodproxy outputParameters: - type: object mapping: $. - name: return-list-operating-systems description: Return a list of operating systems. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getoperatingsystems outputParameters: - type: object mapping: $. - name: disables-production-mode-environment description: Disables production mode for an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsdisableproductionmode outputParameters: - type: object mapping: $. - name: enables-production-mode-environment description: Enables production mode for an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsenableproductionmode outputParameters: - type: object mapping: $. - name: returns-traversal-endpoint-search-entities description: Returns a traversal endpoint for search entities for the environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsearchlist outputParameters: - type: object mapping: $. - name: returns-collection-search-indexes-environment description: Returns a collection of search indexes for an environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsearchindexes outputParameters: - type: object mapping: $. - name: creates-search-index-environment description: Creates a search index for an environment. hints: readOnly: true destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsearchindexes with: body: tools.body outputParameters: - type: object mapping: $. - name: returns-search-configuration-set-application description: Returns a search configuration set for an application hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsearchindex outputParameters: - type: object mapping: $. - name: updates-search-index-environment description: Updates a search index on an environment. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putenvironmentsearchindex with: body: tools.body outputParameters: - type: object mapping: $. - name: removes-and-deletes-specific-search description: Removes and deletes a specific search index from an environment hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deleteenvironmentsearchindex outputParameters: - type: object mapping: $. - name: returns-list-servers description: Returns a list of servers. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsservers outputParameters: - type: object mapping: $. - name: return-details-about-specific-server description: Return details about a specific server. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsserver outputParameters: - type: object mapping: $. - name: modifies-configuration-settings-server description: Modifies configuration settings for a server. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putenvironmentsserver with: body: tools.body outputParameters: - type: object mapping: $. - name: reboots-server description: Reboots a server. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsserverreboot outputParameters: - type: object mapping: $. - name: relaunches-server description: Relaunches a server. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsserverrelaunch outputParameters: - type: object mapping: $. - name: suspends-server description: Suspends a server. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsserversuspend outputParameters: - type: object mapping: $. - name: upgrades-server-precise-xenial description: Upgrades a server from "precise" to "xenial". hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsserverupgrade outputParameters: - type: object mapping: $. - name: provides-links-environment-settings description: Provides links to environment settings. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentssettings outputParameters: - type: object mapping: $. - name: returns-ssl-settings-this-environment description: Returns the SSL settings for this environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getssl outputParameters: - type: object mapping: $. - name: return-list-ssl-certificates description: Return a list of SSL certificates. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcertificates outputParameters: - type: object mapping: $. - name: install-ssl-certificate description: Install an SSL certificate. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postcertificate with: body: tools.body outputParameters: - type: object mapping: $. - name: returns-specific-certificate-certificate-id description: Returns a specific certificate by certificate id. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcertificate outputParameters: - type: object mapping: $. - name: deletes-specific-certificate-its-id description: Deletes a specific certificate by its ID. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deletecertificate outputParameters: - type: object mapping: $. - name: activates-ssl-certificate description: Activates an SSL certificate. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postactivatecertificate outputParameters: - type: object mapping: $. - name: deactivates-active-ssl-certificate description: Deactivates an active SSL certificate. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postdeactivatecertificate outputParameters: - type: object mapping: $. - name: returns-certificate-signing-requests description: Returns certificate signing requests. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcertificatesigningrequests outputParameters: - type: object mapping: $. - name: generates-certificate-signing-request-csr description: Generates a certificate signing request (CSR) for one or more domains. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postcertificatesigningrequest with: body: tools.body outputParameters: - type: object mapping: $. - name: returns-certificate-signing-request-certificate description: Returns the certificate signing request for the certificate specified by id. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getcertificatesigningrequest outputParameters: - type: object mapping: $. - name: deletes-certificate-signing-request description: Deletes the certificate signing request. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deletecertificatesigningrequest outputParameters: - type: object mapping: $. - name: returns-list-environment-variables-associated description: Returns a list of environment variables associated with this environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsvariables outputParameters: - type: object mapping: $. - name: adds-new-environment-variable-environment description: Adds a new environment variable to an environment. hints: readOnly: false destructive: false idempotent: false call: cloud-openapi-full-environments.postenvironmentsvariables with: body: tools.body outputParameters: - type: object mapping: $. - name: get-environment-variable-associated-this description: Get an environment variable associated with this environment. hints: readOnly: true destructive: false idempotent: true call: cloud-openapi-full-environments.getenvironmentsvariable outputParameters: - type: object mapping: $. - name: removes-environment-variable-environment description: Removes an environment variable from an environment. hints: readOnly: false destructive: true idempotent: true call: cloud-openapi-full-environments.deleteenvironmentsvariable outputParameters: - type: object mapping: $. - name: updates-environment-variable-environment description: Updates an environment variable on an environment. hints: readOnly: false destructive: false idempotent: true call: cloud-openapi-full-environments.putenvironmentsvariable with: body: tools.body outputParameters: - type: object mapping: $.