Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Acquia

Acquia Environments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Acquia Environments API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 102 operations across 73 paths, and defines 91 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

102 operations 73 paths 91 schemas 10 DELETE43 GET1 OPTIONS41 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Authentication
OAuth 2.0, API Key, API Key, API Key
Contact
Customer Experience Engineering (CXE)
Resource Areas
1

Authentication & Security 4

Acquia Environments API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow. An API key is passed in the header as Authorization (Codebase_Service_JWT). An API key is passed in the header as Authorization (MEO_Environment_Service_JWT). An API key is passed in the header as Authorization (Site_Service_JWT).

  • Acquia_Cloud_API_Documentation_OAuth2 — All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page. To generate a…
  • Codebase_Service_JWT — Value for the Authorization header parameter.
  • MEO_Environment_Service_JWT — Value for the Authorization header parameter.
  • Site_Service_JWT — Value for the Authorization header parameter.

Paths & Operations 102

Across 73 paths, the API surfaces 102 operations — 10 DELETE, 43 GET, 1 OPTIONS, 41 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Environments 102
DELETE
/environments/{environmentId}
Acquia Deletes a CD Environment.
deleteEnvironment 1 param → 202403404
GET
/environments/{environmentId}
Acquia Return Details About a Specific Environment.
getEnvironment 1 param → 200404
OPTIONS
/environments/{environmentId}
Acquia Displays Environment Options.
optionsEnvironment 1 param → 200404
PUT
/environments/{environmentId}
Acquia Modifies Configuration Settings for an Environment.
putEnvironment 1 param body → 202400403404409
POST
/environments/{environmentId}/actions/change-labeldeprecated
Acquia Change the Label for an Environment.
postChangeEnvironmentLabel 1 param body → 202400403404
POST
/environments/{environmentId}/actions/clear-caches
Acquia Clears the Caches for One or More Domains Attached to This Environment.
postEnvironmentsClearCaches 1 param body → 202403404
POST
/environments/{environmentId}/artifacts/actions/switch
Acquia Deploys an Artifact to This Environment.
postDeployArtifact 1 param body → 202400403404409
GET
/environments/{environmentId}/available-runtimes
Acquia Return a List of Runtimes.
getAvailableRuntimes 1 param → 200404
DELETE
/environments/{environmentId}/cdn
Acquia Disables a CDN for an Environment.
deleteCdnByEnvironmentId 1 param → 200403404409
GET
/environments/{environmentId}/cdn
Acquia Returns the CDN Status for an Environment.
getCdnByEnvironmentId 1 param → 200404
POST
/environments/{environmentId}/cdn
Acquia Enables a CDN for an Environment.
postCdnByEnvironmentId 1 param → 200403404409
GET
/environments/{environmentId}/cloud-actions
Acquia Returns a List of Cloud Actions.
getEnvironmentCloudActions 1 param → 200403404
PUT
/environments/{environmentId}/cloud-actions
Acquia Modifies an Existing List of Cloud Actions.
putEnvironmentCloudActions 1 param body → 200403404
POST
/environments/{environmentId}/cloud-actions/actions/disable
Acquia Disables Cloud Actions.
postEnvironmentCloudActionsDisable 1 param → 200403404
POST
/environments/{environmentId}/cloud-actions/actions/enable
Acquia Enables Cloud Actions.
postEnvironmentCloudActionsEnable 1 param → 200403404
POST
/environments/{environmentId}/cloud-actions/actions/reset
Acquia Resets Cloud Actions.
postEnvironmentCloudActionsReset 1 param → 200403404
POST
/environments/{environmentId}/code
Acquia Deploys Code to This Environment.
postEnvironmentsDeployCode 1 param body → 202400403404409
POST
/environments/{environmentId}/code/actions/import
Acquia Imports a Site to This Environment.
postEnvironmentsImportSite 1 param body → 202400403404409
POST
/environments/{environmentId}/code/actions/switch
Acquia Switches Code on This Environment to a Different Branch or Release Tag.
postEnvironmentsSwitchCode 1 param body → 202400403404409
GET
/environments/{environmentId}/crons
Acquia Return Environment Cron Jobs.
getCronJobsByEnvironmentId 1 param → 200404
POST
/environments/{environmentId}/crons
Acquia Creates a Scheduled Job with Cron.
postEnvironmentCrons 1 param body → 202400403404
DELETE
/environments/{environmentId}/crons/{cronId}
Acquia Deletes a Cron Job.
postEnvironmentCronDelete 2 params → 202403404
GET
/environments/{environmentId}/crons/{cronId}
Acquia Return Details About a Specific Cron Job.
getCron 2 params → 200404
PUT
/environments/{environmentId}/crons/{cronId}
Acquia Modify an Existing Scheduled Job.
putCron 2 params body → 202403404409
POST
/environments/{environmentId}/crons/{cronId}/actions/disable
Acquia Disables a Cron Job.
postEnvironmentCronDisable 2 params → 202403404409
POST
/environments/{environmentId}/crons/{cronId}/actions/enable
Acquia Enables a Cron Job.
postEnvironmentCronEnable 2 params → 202403404409
GET
/environments/{environmentId}/databases
Acquia Returns a List of Databases.
getEnvironmentsDatabases 5 params → 200404
POST
/environments/{environmentId}/databases
Acquia Copies a Database to This Environment.
postEnvironmentsDatabases 1 param body → 202400403404409
GET
/environments/{environmentId}/databases/{databaseName}
Acquia Return Details About a Specific Database.
getEnvironmentsDatabase 2 params → 200404
GET
/environments/{environmentId}/databases/{databaseName}/backups
Acquia Returns a List of Backups.
getEnvironmentsDatabaseBackups 8 params → 200404
POST
/environments/{environmentId}/databases/{databaseName}/backups
Acquia Create a Backup.
postEnvironmentsDatabaseBackups 2 params → 202400403404
DELETE
/environments/{environmentId}/databases/{databaseName}/backups/{backupId}
Acquia Deletes a Database Backup.
deleteEnvironmentsDatabaseBackup 3 params → 202400403404
GET
/environments/{environmentId}/databases/{databaseName}/backups/{backupId}
Acquia Return Details About a Specific Backup.
getEnvironmentsDatabaseBackup 3 params → 200404
GET
/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download
Acquia Downloads the Database Backup File.
getEnvironmentsDatabaseDownloadBackup 3 params → 200403404
POST
/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore
Acquia Restores This Backup to the Appropriate Environment's Database.
postEnvironmentsDatabaseRestoreBackup 3 params → 202400403404409
GET
/environments/{environmentId}/databases/{databaseName}/php-config
Acquia Returns PHP Configuration Details for This Database.
getEnvironmentsDatabasePhpConfig 2 params → 200404
GET
/environments/{environmentId}/dns
Acquia Returns DNS Configuration Details for an Environment.
getEnvironmentsDns 1 param → 200404
GET
/environments/{environmentId}/domains
Acquia Returns a List of Domains.
getEnvironmentsDomains 5 params → 200404
POST
/environments/{environmentId}/domains
Acquia Adds a Domain to the Environment.
postEnvironmentsDomains 1 param body → 202403404409
POST
/environments/{environmentId}/domains/actions/clear-varnishdeprecated
Acquia Clears the Varnish Cache for One or More Domains Attached to This Environment.
postEnvironmentsDomainsClearVarnish 1 param body → 202403404
DELETE
/environments/{environmentId}/domains/{domain}
Acquia Removes the Domain from This Environment.
deleteEnvironmentsDomain 2 params → 202403404
GET
/environments/{environmentId}/domains/{domain}
Acquia Return Details About a Specific Domain.
getEnvironmentsDomain 2 params → 200404
POST
/environments/{environmentId}/domains/{domain}/actions/clear-caches
Acquia Clears the Caches for the Specified Domain.
postEnvironmentsDomainClearCaches 2 params → 202403404
POST
/environments/{environmentId}/domains/{domain}/actions/clear-varnishdeprecated
Acquia Clears the Varnish Cache for the Specified Domain.
postEnvironmentsDomainClearVarnish 2 params → 202403404
GET
/environments/{environmentId}/domains/{domain}/status
Acquia Returns Details About the Domain.
getEnvironmentsDomainStatus 2 params → 200404
GET
/environments/{environmentId}/eips
Acquia Return a List of Web EIPs.
getEIPs 1 param → 200404
POST
/environments/{environmentId}/files
Acquia Copies Files to This Environment.
postEnvironmentsFiles 1 param body → 202400403404409
POST
/environments/{environmentId}/livedev/actions/disabledeprecated
Acquia Disable Live Development on This Environment.
postEnvironmentsDisableLiveDev 1 param body → 202400403404409
POST
/environments/{environmentId}/livedev/actions/enabledeprecated
Acquia Enable Live Development on This Environment.
postEnvironmentsEnableLiveDev 1 param → 202400403404409
GET
/environments/{environmentId}/log-forwarding-destinations
Acquia Returns a Collection of Log Forwarding Destinations for This Environment.
getEnvironmentsLogForwardingDestinations 5 params → 200403404
POST
/environments/{environmentId}/log-forwarding-destinations
Acquia Creates a Log Forwarding Destination.
postEnvironmentsLogForwardingDestinations 1 param body → 202400403404
DELETE
/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}
Acquia Deletes the Specified Log Forwarding Destination.
deleteEnvironmentsLogForwardingDestination 2 params → 202400403404409
GET
/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}
Acquia Returns the Specified Log Forwarding Destination.
getEnvironmentsLogForwardingDestination 2 params → 200403404
PUT
/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}
Acquia Updates an Environment's Log Forwarding Destination.
putEnvironmentsLogForwardingDestination 2 params body → 202400403404409
POST
/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable
Acquia Disables the Specified Log Forwarding Destination.
postEnvironmentsDisableLogForwardingDestination 2 params → 202400403404409
POST
/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable
Acquia Enables the Specified Log Forwarding Destination.
postEnvironmentsEnableLogForwardingDestination 2 params → 202400403404409
GET
/environments/{environmentId}/logs
Acquia Returns a List of Log Files for This Environment Available for Download.
getEnvironmentsLogs 1 param → 200404
GET
/environments/{environmentId}/logs/{logType}
Acquia Downloads the Log File.
getEnvironmentsLog 2 params → 200403404
POST
/environments/{environmentId}/logs/{logType}
Acquia Creates a Log File Snapshot.
postEnvironmentsLog 2 params body → 201400403404409
GET
/environments/{environmentId}/logstream
Acquia Returns a Logstream Url and Metadata.
getEnvironmentsLogstream 1 param → 200404
GET
/environments/{environmentId}/metrics
Acquia Does Not Return Any Data. Allows Traversal to Metrics Groups Endpoints.
getEnvironmentsMetrics 1 param → 200403404
GET
/environments/{environmentId}/metrics/stackmetrics
Acquia Does Not Return Any Data. Allows Traversal to StackMetrics Endpoints.
getEnvironmentsStackMetrics 1 param → 200403404
GET
/environments/{environmentId}/metrics/stackmetrics/data
Acquia Returns StackMetrics Data for the Metrics Specified in the Filter Paramater (e.g., Apache-access, Web-cpu).
getEnvironmentsStackMetricsData 5 params → 200403404
GET
/environments/{environmentId}/metrics/usage
Acquia Retrieves Traversal Links for an Environment's Usage Data.
getEnvironmentsUsageLinks 1 param → 200403404
GET
/environments/{environmentId}/metrics/usage/data
Acquia Retrieves Usage Data for an Environment.
getEnvironmentsUsageData 3 params → 200403404
GET
/environments/{environmentId}/metrics/usage/{usageMetric}
Acquia Retrieves Usage Metric Data for an Environment.
getEnvironmentsUsageMetricData 3 params → 200403404
GET
/environments/{environmentId}/mod-proxy
Acquia Returns the Mod Proxy Status for an Environment.
getModProxyStatus 1 param → 200404409
POST
/environments/{environmentId}/mod-proxy/actions/disable
Acquia Disables Mod Proxy for an Environment.
postDisableModProxy 1 param → 202403404409
POST
/environments/{environmentId}/mod-proxy/actions/enable
Acquia Enables Mod Proxy for an Environment.
postEnableModProxy 1 param → 202403404409
GET
/environments/{environmentId}/operating-systems
Acquia Return a List of Operating Systems.
getOperatingSystems 1 param → 200404
POST
/environments/{environmentId}/production-mode/actions/disable
Acquia Disables Production Mode for an Environment.
postEnvironmentsDisableProductionMode 1 param → 202400403404409
POST
/environments/{environmentId}/production-mode/actions/enable
Acquia Enables Production Mode for an Environment.
postEnvironmentsEnableProductionMode 1 param → 202400403404409
GET
/environments/{environmentId}/search
Acquia Returns a Traversal Endpoint for Search Entities for the Environment.
getEnvironmentSearchList 1 param → 200403404
GET
/environments/{environmentId}/search/indexes
Acquia Returns a Collection of Search Indexes for an Environment.
getEnvironmentSearchIndexes 1 param → 200403404
POST
/environments/{environmentId}/search/indexes
Acquia Creates a Search Index for an Environment.
postEnvironmentSearchIndexes 1 param body → 202403404409
DELETE
/environments/{environmentId}/search/indexes/{indexId}
Acquia Removes and Deletes a Specific Search Index from an Environment
deleteEnvironmentSearchIndex 2 params → 200403404409
GET
/environments/{environmentId}/search/indexes/{indexId}
Acquia Returns a Search Configuration Set for an Application
getEnvironmentSearchIndex 2 params → 200403404
PUT
/environments/{environmentId}/search/indexes/{indexId}
Acquia Updates a Search Index on an Environment.
putEnvironmentSearchIndex 2 params body → 202403404409
GET
/environments/{environmentId}/servers
Acquia Returns a List of Servers.
getEnvironmentsServers 5 params → 200404
GET
/environments/{environmentId}/servers/{serverId}
Acquia Return Details About a Specific Server.
getEnvironmentsServer 2 params → 200404
PUT
/environments/{environmentId}/servers/{serverId}
Acquia Modifies Configuration Settings for a Server.
putEnvironmentsServer 2 params body → 202400403404
POST
/environments/{environmentId}/servers/{serverId}/actions/reboot
Acquia Reboots a Server.
postEnvironmentsServerReboot 2 params → 202400403404
POST
/environments/{environmentId}/servers/{serverId}/actions/relaunch
Acquia Relaunches a Server.
postEnvironmentsServerRelaunch 2 params → 202400403404
POST
/environments/{environmentId}/servers/{serverId}/actions/suspend
Acquia Suspends a Server.
postEnvironmentsServerSuspend 2 params → 202400403404
POST
/environments/{environmentId}/servers/{serverId}/actions/upgrade
Acquia Upgrades a Server from "precise" to "xenial".
postEnvironmentsServerUpgrade 2 params → 202400403404
GET
/environments/{environmentId}/settings
Acquia Provides Links to Environment Settings.
getEnvironmentsSettings 1 param → 200404
GET
/environments/{environmentId}/ssl
Acquia Returns the SSL Settings for This Environment.
getSsl 1 param → 200403404
GET
/environments/{environmentId}/ssl/certificates
Acquia Return a List of SSL Certificates.
getCertificates 1 param → 200404
POST
/environments/{environmentId}/ssl/certificates
Acquia Install an SSL Certificate.
postCertificate 1 param body → 202400403404409
DELETE
/environments/{environmentId}/ssl/certificates/{certificateId}
Acquia Deletes a Specific Certificate by its ID.
deleteCertificate 2 params → 202403404409
GET
/environments/{environmentId}/ssl/certificates/{certificateId}
Acquia Returns a Specific Certificate by Certificate Id.
getCertificate 2 params → 200404
POST
/environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate
Acquia Activates an SSL Certificate.
postActivateCertificate 2 params → 202400403404409
POST
/environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate
Acquia Deactivates an Active SSL Certificate.
postDeactivateCertificate 2 params → 202400403404409
GET
/environments/{environmentId}/ssl/csrs
Acquia Returns Certificate Signing Requests.
getCertificateSigningRequests 1 param → 200404
POST
/environments/{environmentId}/ssl/csrs
Acquia Generates a Certificate Signing Request (CSR) for One or More Domains.
postCertificateSigningRequest 1 param body → 202403404409
DELETE
/environments/{environmentId}/ssl/csrs/{certificateId}
Acquia Deletes the Certificate Signing Request.
deleteCertificateSigningRequest 2 params → 202400403404
GET
/environments/{environmentId}/ssl/csrs/{certificateId}
Acquia Returns the Certificate Signing Request for the Certificate Specified by Id.
getCertificateSigningRequest 2 params → 200403404
GET
/environments/{environmentId}/variables
Acquia Returns a List of Environment Variables Associated with This Environment.
getEnvironmentsVariables 5 params → 200403404
POST
/environments/{environmentId}/variables
Acquia Adds a New Environment Variable to an Environment.
postEnvironmentsVariables 1 param body → 202400403404409
DELETE
/environments/{environmentId}/variables/{environmentVariableName}
Acquia Removes an Environment Variable from an Environment.
deleteEnvironmentsVariable 2 params → 202400403404409
GET
/environments/{environmentId}/variables/{environmentVariableName}
Acquia Get an Environment Variable Associated with This Environment.
getEnvironmentsVariable 2 params → 200403404
PUT
/environments/{environmentId}/variables/{environmentVariableName}
Acquia Updates an Environment Variable on an Environment.
putEnvironmentsVariable 2 params body → 202400403404409

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_environment (22 properties), Acquia_Cloud_API_Documentation_server (14 properties), Acquia_Cloud_API_Documentation_environment-flags (14 properties), Acquia_Cloud_API_Documentation_csr (13 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_server-configuration
object
An array of various configuration settings for the server.
3 properties
Acquia_Cloud_API_Documentation_database-php-config
object
Response schema for a database PHP configuration.
2 properties 2 required
Acquia_Cloud_API_Documentation_available-runtimes
object
3 properties 3 required
Acquia_Cloud_API_Documentation_cloud-action
object
6 properties 6 required
Acquia_Cloud_API_Documentation_deploy-code
object
3 properties 1 required
Acquia_Cloud_API_Documentation_stack-metrics-data
object
An object containing StackMetrics metrics.
3 properties 3 required
Acquia_Cloud_API_Documentation_csr-flags
object
An array of various flags that indicate functionality associated with the CSR.
2 properties
Acquia_Cloud_API_Documentation_environment-options
object
3 properties
Acquia_Cloud_API_Documentation_import-site
object
2 properties 1 required
Acquia_Cloud_API_Documentation_configuration-set
object
An Acquia Search configuration set.
7 properties 6 required
Acquia_Cloud_API_Documentation_database-stub
object
Schema for a stub of information regarding a database.
2 properties 2 required
Acquia_Cloud_API_Documentation_environment-stub
object
Schema for a stub of information regarding an environment.
2 properties 2 required
Acquia_Cloud_API_Documentation_cdn
object
CDN status information.
2 properties 1 required
Acquia_Cloud_API_Documentation_put-cloud-actions
object
A Cloud Action or a series of Cloud Actions paired with enable or disable boolean value.
1 property 1 required
Acquia_Cloud_API_Documentation_certificate-flags
object
An array of various flags that indicate functionality associated with the certificate.
3 properties
Acquia_Cloud_API_Documentation_switch-code
object
2 properties 1 required
Acquia_Cloud_API_Documentation_cloud-action-id
string
A Cloud Action ID.
Acquia_Cloud_API_Documentation_logstream
object
Connection details for Logstream backend.
2 properties 2 required
Acquia_Cloud_API_Documentation_log-forwarding-destination-flags
object
Various flags for this log forwarding destination.
2 properties
Acquia_Cloud_API_Documentation_server
object
Server information.
14 properties 14 required
Acquia_Cloud_API_Documentation_log
object
Details for a log file.
4 properties 4 required
Acquia_Cloud_API_Documentation_application-metadata
object
Application metadata.
1 property
Acquia_Cloud_API_Documentation_server-stub
object
Information about the server this cron job is attached to.
2 properties 2 required
Acquia_Cloud_API_Documentation_cloud-actions-flags
object
Various flags for the Cloud Action.
2 properties
Acquia_Cloud_API_Documentation_artifact-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_database-flags
object
Response schema for database flags.
2 properties
Acquia_Cloud_API_Documentation_indexes
object
A collection of indexes.
4 properties
Acquia_Cloud_API_Documentation_search
object
A collection of links that provides traversal of search endpoints.
1 property 1 required
Acquia_Cloud_API_Documentation_usage
object
A collection of traversal links for an entity.
1 property 1 required
Acquia_Cloud_API_Documentation_eip
object
5 properties 3 required
Acquia_Cloud_API_Documentation_message
object
1 property 1 required
Acquia_Cloud_API_Documentation_cdn-information
object
Domain-specific CDN information, if CDN is enabled.
1 property
Acquia_Cloud_API_Documentation_environment-variables
object
A collection of environment variables.
3 properties 3 required
Acquia_Cloud_API_Documentation_certificates
object
A collection of certificates.
3 properties
Acquia_Cloud_API_Documentation_domains
object
A collection of domains.
3 properties 3 required
Acquia_Cloud_API_Documentation_dns
object
Response schema for environment DNS configuration.
5 properties 5 required
Acquia_Cloud_API_Documentation_cron-flags
object
An array of various flags that indicate functionality associated with cron jobs.
3 properties
Acquia_Cloud_API_Documentation_environment-flags
object
An array of various flags that indicate functionality associated with the environment.
14 properties
Acquia_Cloud_API_Documentation_crons
object
3 properties
Acquia_Cloud_API_Documentation_environment-variable
object
An environment variable key and value.
3 properties 3 required
Acquia_Cloud_API_Documentation_domain-flags
object
An array of flags representing features of the domain.
3 properties 3 required
Acquia_Cloud_API_Documentation_csr
object
A certificate signing request.
13 properties 13 required
Acquia_Cloud_API_Documentation_certificate
object
An SSL certificate.
10 properties 9 required
Acquia_Cloud_API_Documentation_databases
object
A collection of databases.
3 properties 3 required
Acquia_Cloud_API_Documentation_log-forwarding-destinations
object
A collection of Log Forwarding destinations.
3 properties 3 required
Acquia_Cloud_API_Documentation_backup-flags
object
Response schema for database backup flags.
1 property
Acquia_Cloud_API_Documentation_put-cron
object
3 properties
Acquia_Cloud_API_Documentation_environment-usage-metric
object
Provides details about views and visits for an environment.
5 properties 4 required
Acquia_Cloud_API_Documentation_cron
object
12 properties 12 required
Acquia_Cloud_API_Documentation_servers
object
A collection of servers.
3 properties 3 required
Acquia_Cloud_API_Documentation_mod-proxy
object
2 properties 1 required
Acquia_Cloud_API_Documentation_vcs
object
3 properties 3 required
Acquia_Cloud_API_Documentation_eips
object
3 properties
Acquia_Cloud_API_Documentation_log-forwarding-destination-credentials
object
The Log Forwarding destination credentials.
3 properties 1 required
Acquia_Cloud_API_Documentation_domain-status
object
Domain status information.
6 properties 6 required
Acquia_Cloud_API_Documentation_csrs
object
A collection of csrs.
3 properties
Acquia_Cloud_API_Documentation_environment-metadata
object
Environment metadata.
1 property
Acquia_Cloud_API_Documentation_domain
object
Response schema for a domain.
5 properties 5 required
Acquia_Cloud_API_Documentation_environment-settings
object
A collection of links to environment settings.
1 property 1 required
Acquia_Cloud_API_Documentation_message-with-links
object
2 properties 2 required
Acquia_Cloud_API_Documentation_dns-record
object
A DNS record.
2 properties 2 required
Acquia_Cloud_API_Documentation_stack-metrics-metric
object
An object containing StackMetrics datapoints.
4 properties 4 required
Acquia_Cloud_API_Documentation_backups
object
A collection of database backups.
3 properties 3 required
Acquia_Cloud_API_Documentation_ssl
object
The SSL settings for an environment.
3 properties 3 required
Acquia_Cloud_API_Documentation_environment-usage-metrics
object
A collection of usage metrics for an environment.
3 properties 3 required
Acquia_Cloud_API_Documentation_eip-flags
object
Various flags for the Web EIP.
3 properties 1 required
Acquia_Cloud_API_Documentation_log-forwarding-destination
object
The Log Forwarding destination.
11 properties 11 required
Acquia_Cloud_API_Documentation_domain-status-flags
object
An array of hosting flags for the domain.
4 properties
Acquia_Cloud_API_Documentation_subscription-metadata
object
Subscription metadata.
1 property
Acquia_Cloud_API_Documentation_server-flags
object
An array of various flags that indicate functionality for the server.
11 properties
Acquia_Cloud_API_Documentation_post-csr
object
Certificate signing request POST schema.
7 properties 6 required
Acquia_Cloud_API_Documentation_application-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_backup-no-embedded
object
Response schema for a database backup.
8 properties 8 required
Acquia_Cloud_API_Documentation_post-cron
object
3 properties 3 required
Acquia_Cloud_API_Documentation_pagination
object
A collection of pagination properties.
3 properties
Acquia_Cloud_API_Documentation_environment-configuration
object
An array of configuration details for the environment.
12 properties
Acquia_Cloud_API_Documentation_metrics
object
A collection of links that provides traversal of metrics endpoints.
1 property 1 required
Acquia_Cloud_API_Documentation_validation-error
object
A validation error.
2 properties 2 required
Acquia_Cloud_API_Documentation_file-download
object
A JSON response containing the url and url expiration.
2 properties 2 required
Acquia_Cloud_API_Documentation_logs
object
A collection of logs.
3 properties 3 required
Acquia_Cloud_API_Documentation_post-certificate
object
Certificate POST schema.
6 properties 2 required
Acquia_Cloud_API_Documentation_health
object
The current health for this resource.
3 properties
Acquia_Cloud_API_Documentation_cloud-actions
object
3 properties
Acquia_Cloud_API_Documentation_file
string
A binary file response.
Acquia_Cloud_API_Documentation_backup
object
Response schema for a database backup.
9 properties 9 required
Acquia_Cloud_API_Documentation_database
object
Response schema for a database.
10 properties 10 required
Acquia_Cloud_API_Documentation_environment
object
22 properties 22 required
Acquia_Cloud_API_Documentation_operating-systems
object
2 properties 2 required
Acquia_Cloud_API_Documentation_error
object
2 properties 2 required
Acquia_Cloud_API_Documentation_index
object
An Acquia Search index.
10 properties 9 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-environments-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
AE Profile APIs.io
Acquia Content Hub API
AE Profile APIs.io
Acquia Account API
AE Profile APIs.io
Acquia Agreements API
AE Profile APIs.io
Acquia Application Performance Monitoring Services API
AE Profile APIs.io
Acquia Applications API
AE Profile APIs.io
Acquia Cloud IDE API
AE Profile APIs.io
Acquia Codebases API
AE Profile APIs.io
Acquia Current system health API
AE Profile APIs.io
Acquia Distributions API
AE Profile APIs.io
Acquia Email API
AE Profile APIs.io
Acquia Identity Providers API
AE Profile APIs.io
#Environments
← Back to A APIs
API Details
ID
acquia:acquia-environments-api
Docs
https://cloudapi-docs.acquia.com/
Provider
Acquia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network