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