openapi: 3.0.0
info:
  contact:
    name: Customer Experience Engineering (CXE)
    url: https://www.acquia.com
  description: "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n    * Compatible and emergency changes may be made with no advance notice\n    * Disruptive changes may be made with one week notice\n    * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n    * Compatible and emergency changes may be made with no advance notice\n    * Disruptive changes may be made with one month notice\n    * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n    Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n    application/hal+json\n    {\n        \"error\": \"system\",\n        \"message\": \"This action is currently unavailable. Please try again later.\"\n    }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: <a href='https://docs.acquia.com/acquia-cloud/develop/api/auth/' target='_blank'>https://docs.acquia.com/acquia-cloud/develop/api/auth/</a>\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found <a href='https://docs.acquia.com/resources/useful-references' target='_blank'>here</a>. This script uses the <a href='https://oauth2-client.thephpleague.com/' target='_blank'>League/oauth2-client</a> library, installed via Composer.\n"
  title: Acquia Cloud API Account Environments API
  version: 2.0.0
  x-logo:
    altText: Acquia Cloud
    backgroundColor: '#FFFFFF'
    url: assets/cloud-platform.svg
servers: []
tags:
- name: Environments
paths:
  /environments/{environmentId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Deletes a CD environment.
      operationId: deleteEnvironment
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69
                  self:
                    href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1
                message: The environment is being deleted.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Cannot delete CD environments on non-hosted applications:
                  value:
                    error: forbidden
                    message: CD environments cannot be deleted on non-hosted applications.
                Cannot delete environments for managed applications:
                  value:
                    error: forbidden
                    message: Environments cannot be deleted for Service Management-enabled applications.
                Cannot delete environments on Node.js applications:
                  value:
                    error: forbidden
                    message: Environments cannot be deleted on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to delete this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Application Not found:
                  value:
                    error: not_found
                    message: The application you are trying to access does not exist, or you do not have permission to access it.
                Environment Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deletes a CD Environment.
      tags:
      - Environments
      x-cli-name: environments:delete
    get:
      description: 'Return details about a specific environment.


        To find your environment ID via API:


        1. Make a request to GET `/api/applications/[uuid]/environments`.

        2. Find the entry that matches your environment. If you don''t know the application UUID, first make a request to GET `/api/applications`.


        To find your environment ID via cloud.acquia.com:


        1. Open [https://cloud.acquia.com](https://cloud.acquia.com).

        2. Navigate to your application.

        3. Navigate to the environment.

        4. See the environment ID in the browser URL.

        For example, in this URL `https://cloud.acquia.com/app/develop/applications/53785bca-1946-4adc-a022-e50d24686c20/environments/289576-53785bca-1946-4adc-a022-e50d24686c20`, the environment id is `289576-53785bca-1946-4adc-a022-e50d24686c20`.

        '
      operationId: getEnvironment
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  application:
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
                    name: Sample application
                    uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
                _links:
                  available-runtimes:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/available-runtimes
                  cdn:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn
                  cloud-actions:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cloud-actions
                  crons:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons
                  databases:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                  dns:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/dns
                  domains:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains
                  eips:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips
                  logs:
                    href: https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/logs
                  metrics:
                    href: https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics
                  parent:
                    href: https://cloud.acquia.com/api/environments
                  search:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/search
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  servers:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers
                  ssl:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/ssl
                  variables:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/variables
                active_domain: example.com
                application:
                  name: Sample application
                  uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
                artifact: null
                balancer: balancers
                configuration:
                  operating_system: precise
                  php:
                    apcu: 64
                    client_max_body_size: 128
                    interned_strings_buffer: 16
                    max_execution_time: 300
                    max_input_vars: 1000
                    max_post_size: 256
                    memcached_limit: 64
                    memory_limit: 128
                    opcache: 96
                    upload_max_filesize: 128
                    version: '8.3'
                default_domain: sitedev.hosted.acquia-sites.com
                domains:
                - sitedev.hosted.acquia-sites.com
                - example.com
                flags:
                  cde: false
                  cdn: false
                  cloud-actions: false
                  eips: false
                  email: false
                  hsd: false
                  livedev: false
                  multi_region: false
                  multicert: false
                  production: false
                  production_mode: false
                  remote_admin: false
                  varnish: true
                  varnish_over_ssl: false
                gardener:
                  multi-site: example.com/admin/gardens/staging
                  site-update: example.com/admin/gardens/site-update
                id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                image_url: null
                ips:
                - 10.0.1.5
                label: Dev
                name: dev
                platform: cloud
                region: us-east-1
                size: medium
                ssh_url: site.dev@sitedev.ssh.hosted.acquia-sites.com
                status: normal
                type: drupal
                vcs:
                  path: master
                  type: git
                  url: site@svn-3.hosted.acquia-sites.com:site.git
                weight: 0
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Return Details About a Specific Environment.
      tags:
      - Environments
      x-cli-name: environments:find
    options:
      description: Displays environment options.
      operationId: optionsEnvironment
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - default: 32
                    maximum: 512
                    minimum: 32
                    name: apcu
                    step: 1
                  - default: 8
                    maximum: 32
                    minimum: 8
                    name: interned_strings_buffer
                    step: 1
                  - default: 256
                    maximum: 1024
                    minimum: 0
                    name: client_max_body_size
                    step: 1
                  - default: 300
                    maximum: 300
                    minimum: 1
                    name: max_execution_time
                    step: 1
                  - default: 1000
                    maximum: 20000
                    minimum: 500
                    name: max_input_vars
                    step: 1
                  - default: 256
                    maximum: 1024
                    minimum: 64
                    name: max_post_size
                    step: 1
                  - default: 256
                    maximum: 1024
                    minimum: 0
                    name: upload_max_filesize
                    step: 1
                  - default: 128
                    maximum: 1024
                    minimum: 128
                    name: memory_limit
                    step: 1
                  - default: 64
                    maximum: 12288
                    minimum: 0
                    name: memcached_limit
                    step: 64
                  - default: 96
                    maximum: 512
                    minimum: 96
                    name: opcache
                    step: 1
                  - default: null
                    maximum: null
                    minimum: null
                    name: operating_system
                    step: null
                  - default: null
                    maximum: null
                    minimum: null
                    name: version
                    step: null
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93{?filter}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments
                  self:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93
                  sort:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93{?sort}
                    templated: true
                total: 10
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-options'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                No environment or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Displays Environment Options.
      tags:
      - Environments
    put:
      description: Modifies configuration settings for an environment. Note that some settings cannot be configured for certain subscriptions.
      operationId: putEnvironment
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              apcu: 32
              client_max_body_size: 192
              max_execution_time: 10
              max_input_vars: 1000
              max_post_size: 256
              memcached_limit: 128
              memory_limit: 192
              operating_system: focal
              upload_max_filesize: 192
              version: '8.3'
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
          application/x-www-form-urlencoded:
            example:
              apcu: 32
              client_max_body_size: 192
              max_execution_time: 10
              max_input_vars: 1000
              max_post_size: 256
              memcached_limit: 128
              memory_limit: 192
              operating_system: focal
              upload_max_filesize: 192
              version: '8.3'
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5
                  self:
                    href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93
                message: The environment configuration is being updated.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                No changes requested:
                  value:
                    error: forbidden
                    message:
                      system: No environment configuration changes are specified.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot delete CD environments on non-hosted applications:
                  value:
                    error: forbidden
                    message: CD environments cannot be deleted on non-hosted applications.
                Cannot delete environments on Node.js applications:
                  value:
                    error: forbidden
                    message: Environments cannot be deleted on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to delete this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not available for static applications:
                  value:
                    error: not_available
                    message: Environment configuration cannot be modified for static applications.
                Not found:
                  value:
                    error: not_found
                    message: The application you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Conflict:
                  value:
                    error: conflict
                    message: operating_system cannot be configured on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Modifies Configuration Settings for an Environment.
      tags:
      - Environments
      x-cli-name: environments:update
  /environments/{environmentId}/actions/change-label:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      deprecated: true
      description: Change the label for an environment.
      operationId: postChangeEnvironmentLabel
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              label: New Label
            schema:
              properties:
                label:
                  description: The new environment label.
                  type: string
              required:
              - label
              type: object
          application/x-www-form-urlencoded:
            example:
              label: New Label
            schema:
              properties:
                label:
                  description: The new environment label.
                  type: string
              required:
              - label
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Changing label:
                  value:
                    message: Changing environment label.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Label already used:
                  value:
                    error: validation_failed
                    message:
                      label: Another environment within this application already has this label.
                Missing parameter:
                  value:
                    error: validation_failed
                    message:
                      name: 'Missing required parameter(s): example_param'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to change the label for this environment.
                Labels can only be changed on hosted applications:
                  value:
                    error: forbidden
                    message: Environment labels cannot be changed on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Bad Request
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Change the Label for an Environment.
      tags:
      - Environments
      x-cli-name: environments:label-update
  /environments/{environmentId}/actions/clear-caches:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Clear caches for Varnish and Platform CDN (if Platform CDN is enabled).
      operationId: postEnvironmentsClearCaches
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              domains:
              - domain1.example.com
              - domain2.example.com
            schema:
              properties:
                domains:
                  description: A list of domains to clear the caches for.
                  items:
                    format: hostname
                    type: string
                  type: array
              required:
              - domains
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Clearing cache:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/actions/clear-caches
                    message: Caches are being cleared.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Can only be cleared on hosting applications:
                  value:
                    error: forbidden
                    message: Caches cannot be cleared on non-hosted applications.
                Cannot be cleared for Node.js applications:
                  value:
                    error: forbidden
                    message: Caches cannot be cleared on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to clear caches on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Clears the Caches for One or More Domains Attached to This Environment.
      tags:
      - Environments
      x-cli-name: environments:clear-caches
  /environments/{environmentId}/artifacts/actions/switch:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Deploys an artifact to this environment.
      operationId: postDeployArtifact
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              artifact_id: '123'
            schema:
              properties:
                artifact_id:
                  description: The id of the artifact to deploy.
                  type: string
              required:
              - artifact_id
              type: object
          application/x-www-form-urlencoded:
            example:
              artifact_id: '123'
            schema:
              properties:
                artifact_id:
                  description: The id of the artifact to deploy.
                  type: string
              required:
              - artifact_id
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Deploying artifact:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5
                      self:
                        href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/artifacts/actions/switch
                    message: Deploying artifact.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Only ready artifacts can be deployed:
                  value:
                    error: validation_failed
                    message:
                      artifact_id: Only artifacts that are in the 'ready' state can be deployed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Forbidden
        '403':
          content:
            application/hal+json:
              examples:
                Cannot be deployed on Node.js applications:
                  value:
                    error: forbidden
                    message: Artifacts can only be deployed on Node.js applications.
                Cannot be deployed on managed applications:
                  value:
                    error: forbidden
                    message: Artifacts cannot be deployed on Service Management-enabled applications.
                Cannot be deployed on non-hosted applications:
                  value:
                    error: forbidden
                    message: Artifacts cannot be deployed on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to deploy an artifact to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Bad Request
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: conflict
                    message: The artifact with ID 123 does not belong to this application and cannot be deployed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deploys an Artifact to This Environment.
      tags:
      - Environments
      x-cli-name: environments:artifact-deploy
  /environments/{environmentId}/available-runtimes:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a list of available runtimes.
      operationId: getAvailableRuntimes
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93
                  self:
                    href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/available-runtimes
                runtime: php
                versions:
                - '8.2'
                - '8.3'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_available-runtimes'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Available runtimes do not exist on non-hosted applications.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Not found or insufficient permissions:
                  value:
                    error: not_found
                    message: The available runtimes you are trying to access do not exist, or you do not have permission to access them.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return a List of Runtimes.
      tags:
      - Environments
      x-cli-name: environments:runtime-list
  /environments/{environmentId}/cdn:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Disables a CDN for an environment.
      operationId: deleteCdnByEnvironmentId
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/ea01b886-40bb-c028-b3de-4353e25fa462
                  parent:
                    href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4
                  self:
                    href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4/cdn
                message: Deprovisioning Platform CDN.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have sufficient permission to disable CDN for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not enabled:
                  value:
                    error: conflict
                    message: Platform CDN is not enabled for this environment.
                Not supported:
                  value:
                    error: conflict
                    message: This environment does not support Platform CDN.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Disables a CDN for an Environment.
      tags:
      - Environments
      x-cli-name: environments:cdn-disable
    get:
      description: Returns the CDN status for an environment. The CDN must be enabled for the status to be displayed.
      operationId: getCdnByEnvironmentId
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn
                status: active
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cdn'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                CDN not found:
                  value:
                    error: not_found
                    message: The CDN you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns the CDN Status for an Environment.
      tags:
      - Environments
      x-cli-name: environments:cdn-find
    post:
      description: Enables a CDN for an environment.
      operationId: postCdnByEnvironmentId
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/ea01b886-40bb-c028-b3de-4353e25fa462
                  parent:
                    href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4
                  self:
                    href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4/cdn
                message: Provisioning Platform CDN.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have sufficient permission to enable CDN for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Already enabled:
                  value:
                    error: conflict
                    message: Platform CDN is already enabled for this environment.
                Not supported:
                  value:
                    error: conflict
                    message: This environment does not support Platform CDN.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Enables a CDN for an Environment.
      tags:
      - Environments
      x-cli-name: environments:cdn-enable
  /environments/{environmentId}/cloud-actions:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a list of Cloud Actions on an environment.
      operationId: getEnvironmentCloudActions
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions
                      self:
                        href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/f668295f-cbba-472d-8b75-c76ab89e553a
                    description: Backs up all environment databases
                    flags:
                      default: true
                      enabled: false
                    id: f668295f-cbba-472d-8b75-c76ab89e553a
                    label: Backup all databases
                    type: pre-deployment
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions
                      self:
                        href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70
                    description: Turns on maintenance mode on the Drupal site
                    flags:
                      default: true
                      enabled: false
                    id: fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70
                    label: Turn on Drupal maintenance mode
                    type: pre-deployment
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions
                      self:
                        href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/102590e4-382b-4726-8b3f-855d5ca4225d
                    description: Clears all Drupal caches
                    flags:
                      default: false
                      enabled: false
                    id: 102590e4-382b-4726-8b3f-855d5ca4225d
                    label: Clear all Drupal caches
                    type: pre-deployment
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions{?filter}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27
                  self:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions
                  sort:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions{?sort}
                    templated: true
                total: 3
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-actions'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage Cloud Actions on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Cloud Actions unavailable:
                  value:
                    error: not_found
                    message: Cloud Actions are not available for this environment.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns a List of Cloud Actions.
      tags:
      - Environments
      x-cli-name: environments:cloud-actions-find
    put:
      description: Modifies an existing list of Cloud Actions on an environment.
      operationId: putEnvironmentCloudActions
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              cloud-actions:
                9440be70-c042-47ae-9134-e85acbbd6edf: false
                fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70: true
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_put-cloud-actions'
          application/x-www-form-urlencoded:
            example:
              cloud-actions:
                9440be70-c042-47ae-9134-e85acbbd6edf: false
                fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70: true
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_put-cloud-actions'
        required: true
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/42047305-e30c-4c7e-931f-5407ce55a9e9
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27
                  self:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions
                message: Cloud Actions have been updated.
                notification: 42047305-e30c-4c7e-931f-5407ce55a9e9
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage Cloud Actions on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Modifies an Existing List of Cloud Actions.
      tags:
      - Environments
      x-cli-name: environments:cloud-actions-update
  /environments/{environmentId}/cloud-actions/actions/disable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Disables Cloud Actions on an environment.
      operationId: postEnvironmentCloudActionsDisable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/2d49d11c-f81d-46dd-89f2-fb7f2f54335f
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27
                  self:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions
                message: Cloud Actions have been disabled.
                notification: 2d49d11c-f81d-46dd-89f2-fb7f2f54335f
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage Cloud Actions on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Disables Cloud Actions.
      tags:
      - Environments
      x-cli-name: environments:cloud-actions-disable
  /environments/{environmentId}/cloud-actions/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Enables Cloud Actions on an environment.
      operationId: postEnvironmentCloudActionsEnable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/003e8200-6105-48bc-80a7-6ba378ac8e91
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions
                  self:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions/enable
                message: Cloud Actions have been enabled.
                notification: 003e8200-6105-48bc-80a7-6ba378ac8e91
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage Cloud Actions on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Enables Cloud Actions.
      tags:
      - Environments
      x-cli-name: environments:cloud-actions-enable
  /environments/{environmentId}/cloud-actions/actions/reset:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Resets Cloud Actions to the default on an environment.
      operationId: postEnvironmentCloudActionsReset
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/e5a15d33-ee5a-4af1-bfeb-4e76b3d33b4b
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions
                  self:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions/reset
                message: Cloud Actions have been reset to the default.
                notification: e5a15d33-ee5a-4af1-bfeb-4e76b3d33b4b
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage Cloud Actions on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Resets Cloud Actions.
      tags:
      - Environments
      x-cli-name: environments:cloud-actions-reset
  /environments/{environmentId}/code:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Deploys code to this environment.
      operationId: postEnvironmentsDeployCode
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              cloud-actions: []
              message: Optional commit message
              source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_deploy-code'
          application/x-www-form-urlencoded:
            example:
              cloud-actions: []
              message: Optional commit message
              source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_deploy-code'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Code being deployed:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/a49eeebb-0929-444a-972c-07b94ce93ab9
                      parent:
                        href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93
                      self:
                        href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/code
                    message: Deploying code.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Can only be deployed to environment within same application:
                  value:
                    error: validation_failed
                    message:
                      source: Code can only be deployed from an environment within the same application.
                Missing parameter:
                  value:
                    error: validation_failed
                    message:
                      name: 'Missing required parameter(s): example_param'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot deploy code on Node.js applications:
                  value:
                    error: forbidden
                    message: Code cannot be deployed on Node.js applications.
                Cannot deploy code on non-hosted applications:
                  value:
                    error: forbidden
                    message: Code cannot be deployed on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to deploy code to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Cannot be deployed to itself:
                  value:
                    error: conflict
                    message: Code cannot be deployed from an environment to itself.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deploys Code to This Environment.
      tags:
      - Environments
      x-cli-name: environments:code-deploy
  /environments/{environmentId}/code/actions/import:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Imports a site to this environment.
      operationId: postEnvironmentsImportSite
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              name: Drupal 8
              url: http://www.example.com/path/to/site.tar.gz
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_import-site'
          application/x-www-form-urlencoded:
            example:
              name: Drupal 8
              url: http://www.example.com/path/to/site.tar.gz
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_import-site'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Site is being imported:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/d82a122d-b7b8-46fc-9999-39cb824fac8d
                      self:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/code/actions/import
                    message: The site is being imported.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Cannot be imported on application:
                  value:
                    error: validation_failed
                    message:
                      general: Sites cannot be imported on this application.
                File format not supported:
                  value:
                    error: validation_failed
                    message:
                      general: The installation file is not supported. It must be a Drush make file (.make) or a Gzip-compressed tar archive (.tar.gz or .tgz).
                Invalid URL:
                  value:
                    error: validation_failed
                    message:
                      url: Invalid URL format.
                Missing parameter:
                  value:
                    error: validation_failed
                    message:
                      name: 'Missing required parameter(s): example_param'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to deploy code to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: conflict
                    message: Sites cannot be imported on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Imports a Site to This Environment.
      tags:
      - Environments
      x-cli-name: environments:site-import
  /environments/{environmentId}/code/actions/switch:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Switches code on this environment to a different branch or release tag.
      operationId: postEnvironmentsSwitchCode
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              branch: my-feature-branch
              cloud-actions: []
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_switch-code'
          application/x-www-form-urlencoded:
            example:
              branch: my-feature-branch
              cloud-actions: []
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_switch-code'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Switching code:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/bfd9a39b-a85e-4de3-8a70-042d1c7e607a
                      self:
                        href: https://cloud.acquia.com/api/environments/861-ddccebef-eb2f-48ce-a92f-e0a16a3a0b53/code/actions/switch
                    message: Switching code.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Branch does not exist:
                  value:
                    error: validation_failed
                    message:
                      branch: The branch or tag "my-feature-branch" does not exist within this environment.
                Invalid branch name:
                  value:
                    error: validation_failed
                    message:
                      branch: The branch name contains invalid characters.
                Missing parameter:
                  value:
                    error: validation_failed
                    message:
                      name: 'Missing required parameter(s): example_param'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot deploy code on Node.js applications:
                  value:
                    error: forbidden
                    message: Code cannot be switched on Node.js applications.
                Cannot deploy code on non-hosted applications:
                  value:
                    error: forbidden
                    message: Code cannot be deployed on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to deploy code to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Switches Code on This Environment to a Different Branch or Release Tag.
      tags:
      - Environments
      x-cli-name: environments:code-switch
  /environments/{environmentId}/crons:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a list of the cron jobs on an environment.
      operationId: getCronJobsByEnvironmentId
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/e82b77cc-a9ed-4458-b12c-d87af1a795ad
                    command: /usr/local/bin/drush cc all
                    day_month: '*'
                    day_week: '*'
                    environment:
                      id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      enabled: true
                      on_any_web: false
                      system: false
                    hour: '7'
                    id: e82b77cc-a9ed-4458-b12c-d87af1a795ad
                    label: Clear drush caches
                    minute: '25'
                    month: '*'
                    server:
                      id: '18'
                      name: web-18
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/8eea655e-71be-4c71-bf5b-9c5c9a5c5b43
                    command: /usr/local/bin/drush -r /var/www/html/qa3/docroot ah-db-backup dbname
                    day_month: '*'
                    day_week: '*'
                    environment:
                      id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      enabled: false
                      on_any_web: false
                      system: true
                    hour: '9'
                    id: 8eea655e-71be-4c71-bf5b-9c5c9a5c5b43
                    label: Run backup
                    minute: '12'
                    month: '*'
                    server:
                      id: '6'
                      name: web-6
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_crons'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Non-hosted application:
                  value:
                    error: not_found
                    message: Cron jobs do not exist on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Return Environment Cron Jobs.
      tags:
      - Environments
      x-cli-name: environments:cron-job-list
    post:
      description: Creates a scheduled job with cron on an environment.
      operationId: postEnvironmentCrons
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              command: /usr/local/bin/drush cc all
              frequency: '*/30 * * * *'
              label: My New Cron
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-cron'
          application/x-www-form-urlencoded:
            example:
              command: /usr/local/bin/drush cc all
              frequency: '*/30 * * * *'
              label: My New Cron
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-cron'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Adding cron:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/01fde3bb-b65f-4629-b761-9072a35e8e50
                      parent:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons
                      self:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/936a55fd-29eb-4317-bb6e-ad2a94b24589
                    message: Creating a new cron.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Invalid frequency:
                  value:
                    error: validation_failed
                    message:
                      frequency: The cron frequency does not appear to be valid.
                Label in use:
                  value:
                    error: validation_failed
                    message:
                      name: The label for the cron is already used by another cron. Please choose another label.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to create a cron in this environment.
                Node.js application:
                  value:
                    error: forbidden
                    message: Cron jobs are not available for Node.js applications.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: Cron jobs cannot be created on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Cron not found:
                  value:
                    error: not_found
                    message: The cron does not belong to this environment, and cannot be updated.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Creates a Scheduled Job with Cron.
      tags:
      - Environments
      x-cli-name: environments:cron-create
  /environments/{environmentId}/crons/{cronId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Deletes a cron job.
      operationId: postEnvironmentCronDelete
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Deleting cron:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/767cee8d-05f6-4761-a3dc-755957dfc9e6
                      parent:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons
                      self:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1891
                    message: Deleting cron.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to delete this cron.
                Node.js application:
                  value:
                    error: forbidden
                    message: Cron jobs are not available for Node.js applications.
                Non hosted application:
                  value:
                    error: forbidden
                    message: Cron jobs cannot be deleted on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment mismatch:
                  value:
                    error: not_found
                    message: The cron does not belong to this environment, and cannot be removed.
                No environment or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deletes a Cron Job.
      tags:
      - Environments
      x-cli-name: environments:cron-delete
    get:
      description: Return details about a specific cron job by environment ID and cron job ID.
      operationId: getCron
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/e82b77cc-a9ed-4458-b12c-d87af1a795ad
                command: /usr/local/bin/drush cc all
                day_month: '*'
                day_week: '*'
                environment:
                  id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  name: dev
                flags:
                  enabled: true
                  on_any_web: true
                  system: false
                hour: '7'
                id: e82b77cc-a9ed-4458-b12c-d87af1a795ad
                label: Clear drush caches
                minute: '25'
                month: '*'
                server:
                  id: '18'
                  name: web-18
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cron'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Non-hosted application:
                  value:
                    error: not_found
                    message: Cron jobs do not exist on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Return Details About a Specific Cron Job.
      tags:
      - Environments
      x-cli-name: environments:cron-find
    put:
      description: Modify an existing scheduled job on an environment.
      operationId: putCron
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id'
      requestBody:
        content:
          application/hal+json:
            example:
              command: /usr/local/bin/drush7 cc all
              frequency: '*/5 * * * *'
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_put-cron'
          application/x-www-form-urlencoded:
            example:
              command: /usr/local/bin/drush7 cc all
              frequency: '*/5 * * * *'
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_put-cron'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Update cron:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/ba232d96-dfe7-4850-9ca7-02e01a04f58d
                      parent:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons
                      self:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/2582
                    message: Updating cron.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to modify this cron.
                Node.js applications:
                  value:
                    error: forbidden
                    message: Cron jobs are not available for Node.js applications.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: Cron jobs are not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment mismatch:
                  value:
                    error: not_found
                    message: The cron does not belong to this environment, and cannot be updated.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Invalid frequency:
                  value:
                    error: validation_failed
                    message:
                      frequency: The cron frequency does not appear to be valid.
                Label in use:
                  value:
                    error: conflict
                    message:
                      name: The label for the cron is already used by another cron. Please choose another label.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Modify an Existing Scheduled Job.
      tags:
      - Environments
      x-cli-name: environments:cron-update
  /environments/{environmentId}/crons/{cronId}/actions/disable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Disables a cron job.
      operationId: postEnvironmentCronDisable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/7b37b885-8ae4-454b-b8fa-ffaeff54f6a4
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/crons/1234/actions
                  self:
                    href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/crons/1234/actions/disable
                message: The cron is being disabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to modify this cron.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: Cron jobs cannot be disabled on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment mismatch:
                  value:
                    error: not_found
                    message: The cron does not belong to this environment, and cannot be disabled.
                No cron or permission:
                  value:
                    error: not_found
                    message: The cron you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Action currently unavailable:
                  value:
                    error: conflict
                    message: The cron is already disabled. No action taken.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Disables a Cron Job.
      tags:
      - Environments
      x-cli-name: environments:cron-disable
  /environments/{environmentId}/crons/{cronId}/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Enables a cron job.
      operationId: postEnvironmentCronEnable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/ceda2e82-54b7-4181-ae97-6a3163b187b8
                  parent:
                    href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1889/actions
                  self:
                    href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1889/actions/enable
                message: The cron is being enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to modify this cron.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: Cron jobs cannot be enabled on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment mismatch:
                  value:
                    error: not_found
                    message: The cron does not belong to this environment, and cannot be enabled.
                No cron or permission:
                  value:
                    error: not_found
                    message: The cron you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Action currently unavailable:
                  value:
                    error: conflict
                    message: The cron is already enabled. No action taken.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Enables a Cron Job.
      tags:
      - Environments
      x-cli-name: environments:cron-enable
  /environments/{environmentId}/databases:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Returns a list of databases.


        Filterable fields:

        * `name`

        * `id`


        Sortable fields:

        * `name`

        * `id`

        '
      operationId: getEnvironmentsDatabases
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14
                    db_host: dbhost.example.com
                    environment:
                      id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      default: true
                    id: 14
                    name: my_db
                    password: supersecretdbpassword1!
                    ssh_host: sshhost.example.com
                    url: mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db
                    user_name: my_db_user
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/25-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/15
                    db_host: dbhost.example.com
                    environment:
                      id: 25-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      default: false
                    id: 15
                    name: my_db_stage
                    password: supersecretdbpassword1!
                    ssh_host: sshhost.example.com
                    url: mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db_stage
                    user_name: my_db_user
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?filter}
                    templated: true
                  limit:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?limit}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                  sort:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?sort}
                    templated: true
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_databases'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Do not exist on Node.js applications:
                  value:
                    error: not_available
                    message: Databases do not exist on Node.js applications
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Databases do not exist on non-hosted applications.
                Not found:
                  value:
                    error: not_found
                    message: The application you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a List of Databases.
      tags:
      - Environments
      x-cli-name: environments:database-list
    post:
      description: Copies a database to this environment.
      operationId: postEnvironmentsDatabases
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              name: db_name
              source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851
            schema:
              properties:
                name:
                  description: The name of the database to copy to the selected environment.
                  type: string
                source:
                  description: The ID of the environment to copy the database from.
                  minLength: 38
                  type: string
              required:
              - name
              - source
              type: object
          application/x-www-form-urlencoded:
            example:
              name: db_name
              source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851
            schema:
              properties:
                name:
                  description: The name of the database to copy to the selected environment.
                  type: string
                source:
                  description: The ID of the environment to copy the database from.
                  minLength: 38
                  type: string
              required:
              - name
              - source
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Database being copied:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/a49eeebb-0929-444a-972c-07b94ce93ab9
                      parent:
                        href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93
                      self:
                        href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/databases
                    message: The database is being copied
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Database does not exist in environment:
                  value:
                    error: validation_failed
                    message:
                      database: The database does not exist in this environment.
                Missing parameter:
                  value:
                    error: validation_failed
                    message:
                      name: 'Missing required parameter(s): example_param'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Action not available on Node.js applications:
                  value:
                    error: forbidden
                    message: Databases cannot be copied on Node.js applications.
                Action not available on non-hosted applications:
                  value:
                    error: forbidden
                    message: Databases cannot be copied on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to copy this database.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Cannot be copied to itself:
                  value:
                    error: conflict
                    message: A database cannot be copied from an environment to itself.
                Cannot be copied to production:
                  value:
                    error: conflict
                    message: A database cannot be copied to an environment that is currently in production mode.
                Must belong to same application:
                  value:
                    error: conflict
                    message: The environments do not belong to the same application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Copies a Database to This Environment.
      tags:
      - Environments
      x-cli-name: environments:database-copy
  /environments/{environmentId}/databases/{databaseName}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Return details about a specific database.
      operationId: getEnvironmentsDatabase
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  backups:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14/backups
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                  php-config:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14/php-config
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14
                db_host: dbhost.example.com
                environment:
                  id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  name: dev
                flags:
                  default: true
                id: 14
                name: my_db
                password: supersecretdbpassword1!
                ssh_host: sshhost.example.com
                url: mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db
                user_name: my_db_user
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Database not found:
                  value:
                    error: not_found
                    message: The database you are trying to access does not exist, or you do not have permission to access it.
                Do not exist on Node.js applications:
                  value:
                    error: not_available
                    message: Databases do not exist on Node.js applications
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Databases do not exist on non-hosted applications.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return Details About a Specific Database.
      tags:
      - Environments
      x-cli-name: environments:database-find
  /environments/{environmentId}/databases/{databaseName}/backups:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Returns a list of backups.


        Filterable fields:

        * `type`

        * `created` Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date.


        Sortable fields:

        * `type`

        * `created`

        '
      operationId: getEnvironmentsDatabaseBackups
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_deprecated-from'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_deprecated-to'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/1/actions/download
                      parent:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                      self:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/1
                    completed_at: '2012-05-15T12:00:00Z'
                    database:
                      id: 14
                      name: db_name
                    environment:
                      id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: Production
                    flags:
                      deleted: false
                    id: 1
                    started_at: '2012-05-15T12:00:00Z'
                    type: daily
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/2/actions/download
                      parent:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                      self:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/2
                    completed_at: '2012-03-28T12:00:01Z'
                    database:
                      id: 14
                      name: db_name
                    environment:
                      id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: Production
                    flags:
                      deleted: false
                    id: 2
                    started_at: '2012-03-28T12:00:00Z'
                    type: daily
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/3/actions/download
                      parent:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                      self:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/3
                    completed_at: '2017-01-08T04:00:01Z'
                    database:
                      id: 14
                      name: db_name
                    environment:
                      id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: Production
                    flags:
                      deleted: false
                    id: 3
                    started_at: '2017-01-08T04:00:00Z'
                    type: daily
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/4/actions/download
                      parent:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases
                      self:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/4
                    completed_at: '2017-01-08T05:00:03Z'
                    database:
                      id: 14
                      name: db_name
                    environment:
                      id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: Production
                    flags:
                      deleted: false
                    id: 4
                    started_at: '2017-01-08T05:00:02Z'
                    type: daily
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?filter}
                    templated: true
                  limit:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?limit}
                    templated: true
                  offset:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?offset}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name
                  self:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups
                  sort:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?sort}
                    templated: true
                pagination:
                  limit: 2
                  offset: 0
                  total: 2
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backups'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Do not exist on Node.js applications:
                  value:
                    error: not_available
                    message: Databases do not exist on Node.js applications
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Databases do not exist on non-hosted applications.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a List of Backups.
      tags:
      - Environments
      x-cli-name: environments:database-backup-list
    post:
      description: Create a backup.
      operationId: postEnvironmentsDatabaseBackups
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Creating backup:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      parent:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups/
                    message: Creating the backup.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Database does not exist in environment:
                  value:
                    error: validation_failed
                    message:
                      database: The database does not exist in this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Action not available on Node.js applications:
                  value:
                    error: forbidden
                    message: Database backups do not exist on Node.js applications.
                Action not available on non-hosted applications:
                  value:
                    error: forbidden
                    message: Database backups are not available on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to backup this database.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Create a Backup.
      tags:
      - Environments
      x-cli-name: environments:database-backup-create
  /environments/{environmentId}/databases/{databaseName}/backups/{backupId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Deletes a database backup.
      operationId: deleteEnvironmentsDatabaseBackup
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_backup-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Deleting backup:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      parent:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups/1
                    message: Deleting the database backup.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Database does not exist in environment:
                  value:
                    error: validation_failed
                    message:
                      backup: The database does not exist in this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Action not available on Node.js applications:
                  value:
                    error: forbidden
                    message: Database backups do not exist on Node.js applications.
                Action not available on non-hosted applications:
                  value:
                    error: forbidden
                    message: Database backups are not available on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to delete this backup.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Database not found:
                  value:
                    error: not_found
                    message: The database you are trying to access does not exist, or you do not have permission to access it.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deletes a Database Backup.
      tags:
      - Environments
      x-cli-name: environments:database-backup-delete
    get:
      description: Return details about a specific backup.
      operationId: getEnvironmentsDatabaseBackup
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_backup-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  database:
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name
                    id: 14
                    name: db_name
                  environment:
                    _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                    id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                    name: Production
                _links:
                  download:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups/1/actions/download
                  parent:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups
                  self:
                    href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups/1
                completed_at: '2012-05-15T12:00:00Z'
                database:
                  id: 14
                  name: db_name
                environment:
                  id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  name: Production
                flags:
                  deleted: false
                id: 1
                started_at: '2012-05-15T12:00:00Z'
                type: daily
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Database backup not found:
                  value:
                    error: not_found
                    message: The database backup you are trying to access does not exist, or you do not have permission to access it.
                Do not exist on Node.js applications:
                  value:
                    error: not_available
                    message: Databases backups do not exist on Node.js applications
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Databases backups do not exist on non-hosted applications.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return Details About a Specific Backup.
      tags:
      - Environments
      x-cli-name: environments:database-backup-find
  /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Downloads the database backup file.
      operationId: getEnvironmentsDatabaseDownloadBackup
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_backup-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/8a1c8503-0dae-4b08-a917-d2f01f4971ca
                  parent:
                    href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions
                  self:
                    href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions/download
                expires_at: '2020-06-16T15:15:05+00:00'
                url: http://example.com/backup.gz
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file-download'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file'
            text/html:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file-download'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to download this backup.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Database not found:
                  value:
                    error: not_found
                    message: The database backup you are trying to access does not exist, or you do not have permission to access it.
                Do not exist on Node.js applications:
                  value:
                    error: not_available
                    message: Databases backups do not exist on Node.js applications
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Databases backups do not exist on non-hosted applications.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Downloads the Database Backup File.
      tags:
      - Environments
      x-cli-name: environments:database-backup-download
  /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Restores this backup to the appropriate environment's database.
      operationId: postEnvironmentsDatabaseRestoreBackup
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_backup-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Restoring backup:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/f295cd91-c3c0-422c-a1ab-e91fe972041a
                      self:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases/test_database_1/backups/4189098/actions/restore
                    message: Restoring the database backup.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Does not belong to environment:
                  value:
                    error: validation_error
                    message:
                      backup: The database backup does not belong to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Action not available on Node.js applications:
                  value:
                    error: forbidden
                    message: Database backups cannot be restored on Node.js applications.
                Action not available on non-hosted applications:
                  value:
                    error: forbidden
                    message: Database backups cannot be restored on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to restore a backup to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Database not found:
                  value:
                    error: not_found
                    message: The database you are trying to access does not exist, or you do not have permission to access it.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Database not available:
                  value:
                    error: conflict
                    message: The database backup has not completed yet, and cannot be restored at this time.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Restores This Backup to the Appropriate Environment's Database.
      tags:
      - Environments
      x-cli-name: environments:database-backup-restore
  /environments/{environmentId}/databases/{databaseName}/php-config:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns PHP configuration details for this database.
      operationId: getEnvironmentsDatabasePhpConfig
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/databases/mydb
                  self:
                    href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/databases/mydb/php-config
                drupal: "if (file_exists('/var/www/site-php')) {\n\trequire '/var/www/site-php/sitegroup/myenv-settings.inc';\n}"
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-php-config'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Database not found:
                  value:
                    error: not_found
                    message: The database you are trying to access does not exist, or you do not have permission to access it.
                Do not exist on Node.js applications:
                  value:
                    error: not_available
                    message: Databases do not exist on Node.js applications
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Databases do not exist on non-hosted applications.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns PHP Configuration Details for This Database.
      tags:
      - Environments
      x-cli-name: environments:database-php-config-find
  /environments/{environmentId}/dns:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns environment DNS configuration information for apex domain and subdomains.
      operationId: getEnvironmentsDns
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93
                  self:
                    href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/dns
                apex_domain:
                - type: A
                  value: 192.0.2.1
                - type: AAAA
                  value: 2001:0db8:1729:aa03:80b5:1c65:bea:42ff
                global_configuration:
                  apex_domain:
                  - type: A
                    value: 192.0.2.3
                  - type: A
                    value: 192.0.2.4
                  - type: AAAA
                    value: 2001:0db8:1730:aa03:80b5:1c65:bea:42ff
                  subdomains:
                  - type: CNAME
                    value: subdomain.example.com
                regional_configuration:
                  apex_domain:
                  - type: A
                    value: 192.0.2.1
                  - type: AAAA
                    value: 2001:0db8:1729:aa03:80b5:1c65:bea:42ff
                  subdomains:
                  - type: CNAME
                    value: subdomain.example.com
                subdomains:
                - type: CNAME
                  value: subdomain.example.com
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns DNS Configuration Details for an Environment.
      tags:
      - Environments
      x-cli-name: environments:dns-find
  /environments/{environmentId}/domains:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Returns a list of domains.


        Filterable fields:

        * `hostname`


        Sortable fields:

        * `hostname`

        '
      operationId: getEnvironmentsDomains
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/www.example.com
                      status:
                        href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/www.example.com/status
                    cdn:
                      status: installing
                    environment:
                      id: 24-abcd1234-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      active: true
                      default: true
                      wildcard: false
                    hostname: www.example.com
                  - _links:
                      dns:
                        href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/dns
                      self:
                        href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/other.example.com
                      status:
                        href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/other.example.com/status
                    cdn: null
                    environment:
                      id: 24-abcd1234-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      active: false
                      default: false
                      wildcard: false
                    hostname: other.example.com
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/*.example.com
                    cdn:
                      status: active
                    environment:
                      id: 24-abcd1234-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      active: false
                      default: false
                      wildcard: true
                    hostname: '*.example.com'
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains
                total: 3
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domains'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Only available for hosted applications:
                  value:
                    error: not_found
                    message: Domain names do not exist on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a List of Domains.
      tags:
      - Environments
      x-cli-name: environments:domain-list
    post:
      description: Adds a domain to the environment.
      operationId: postEnvironmentsDomains
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              hostname: example.com
            schema:
              properties:
                hostname:
                  description: The domain name to add.
                  format: hostname
                  maxLength: 253
                  minLength: 3
                  type: string
              type: object
          application/x-www-form-urlencoded:
            example:
              hostname: example.com
            schema:
              properties:
                hostname:
                  description: The domain name to add.
                  maxLength: 253
                  minLength: 3
                  type: string
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Adding domain:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5
                      parent:
                        href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d
                      self:
                        href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/domains
                    message: Adding domain example.com
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Can only be created on hosted applications:
                  value:
                    error: forbidden
                    message: Domains cannot be created on non-hosted applications.
                Cannot be added with Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: Domains cannot be added on Acquia Cloud Free subscriptions.
                Cannot be added with Acquia Cloud Site Factory:
                  value:
                    error: forbidden
                    message: Domains cannot be added on Acquia Cloud Site Factory applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to add a domain to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Cannot add names to application:
                  value:
                    error: forbidden
                    message: You cannot add domain names on this application.
                Domain name already used:
                  value:
                    error: forbidden
                    message: The domain name cannot be used, as it already exists within this application's environments.
                Error adding domain name:
                  value:
                    error: forbidden
                    message: This domain cannot be added to this environment. For more details, contact Acquia Support.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Adds a Domain to the Environment.
      tags:
      - Environments
      x-cli-name: environments:domain-create
  /environments/{environmentId}/domains/actions/clear-varnish:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      deprecated: true
      description: Clears the Varnish cache for one or more domains attached to this environment.
      operationId: postEnvironmentsDomainsClearVarnish
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              domains:
              - domain1.example.com
              - domain2.example.com
            schema:
              properties:
                domains:
                  description: A list of domains to clear the Varnish cache for.
                  items:
                    format: hostname
                    type: string
                  type: array
              required:
              - domains
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Clearing cache:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/actions/clear-varnish
                    message: Varnish is being cleared for the selected domains.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Can only be cleared on hosting applications:
                  value:
                    error: forbidden
                    message: Varnish cannot be cleared on non-hosted applications.
                Cannot be cleared for Node.js applications:
                  value:
                    error: forbidden
                    message: Varnish cannot be cleared on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to clear Varnish on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Clears the Varnish Cache for One or More Domains Attached to This Environment.
      tags:
      - Environments
      x-cli-name: environments:domains-clear-varnish
  /environments/{environmentId}/domains/{domain}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Removes the domain from this environment.
      operationId: deleteEnvironmentsDomain
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Deleting domain:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/67b7f08f-2dff-4c86-a8a0-35c4196880a3
                      parent:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/domains
                      self:
                        href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/domains/example.com
                    message: Removing the domain example.com
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Can only be removed on hosted applications:
                  value:
                    error: forbidden
                    message: Domains cannot be removed on non-hosted applications.
                Cannot be removed with Acquia Cloud Site Factory:
                  value:
                    error: forbidden
                    message: Domains cannot be removed on Acquia Cloud Site Factory applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to remove domains on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Domain not found:
                  value:
                    error: not_found
                    message: The domain you are trying to delete does not exist, or you do not have permission to modify it.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Removes the Domain from This Environment.
      tags:
      - Environments
      x-cli-name: environments:domain-delete
    get:
      description: Return details about a specific domain.
      operationId: getEnvironmentsDomain
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains
                  self:
                    href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains/example.com
                  status:
                    href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains/example.com/status
                cdn:
                  status: active
                environment:
                  id: 24-47c9ae06-2a57-11e9-b210-d663bd873d93
                  name: dev
                flags:
                  active: true
                  default: false
                  wildcard: false
                hostname: example.com
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Only exist on hosted applications:
                  value:
                    error: not_found
                    message: Domain names do not exist on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return Details About a Specific Domain.
      tags:
      - Environments
      x-cli-name: environments:domain-find
  /environments/{environmentId}/domains/{domain}/actions/clear-caches:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Clear caches for Varnish and Platform CDN (if Platform CDN is enabled).
      operationId: postEnvironmentsDomainClearCaches
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Clearing cache:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/example.com/actions/clear-caches
                    message: Caches are being cleared.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Can only be cleared on hosting applications:
                  value:
                    error: forbidden
                    message: Caches cannot be cleared on non-hosted applications.
                Cannot be cleared for Node.js applications:
                  value:
                    error: forbidden
                    message: Caches cannot be cleared on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to clear caches on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Clears the Caches for the Specified Domain.
      tags:
      - Environments
      x-cli-name: environments:domain-clear-caches
  /environments/{environmentId}/domains/{domain}/actions/clear-varnish:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      deprecated: true
      description: Clears the Varnish cache for the specified domain.
      operationId: postEnvironmentsDomainClearVarnish
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Clearing cache:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/example.com/actions/clear-varnish
                    message: Varnish is being cleared for domain 'example.com'.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                Can only be cleared on hosting applications:
                  value:
                    error: forbidden
                    message: Varnish cannot be cleared on non-hosted applications.
                Cannot be cleared for Node.js applications:
                  value:
                    error: forbidden
                    message: Varnish cannot be cleared on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to clear Varnish on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Clears the Varnish Cache for the Specified Domain.
      tags:
      - Environments
      x-cli-name: environments:domain-clear-varnish
  /environments/{environmentId}/domains/{domain}/status:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns details about the domain.
      operationId: getEnvironmentsDomainStatus
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains/example.com
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains/example.com/status
                cnames:
                - another.example.com
                environment:
                  id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  name: dev
                flags:
                  acquia_hosted: true
                  active: true
                  default: false
                  dns_resolves: true
                hostname: example.com
                ip_addresses:
                - 12.23.34.45
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-status'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Unable to determine status:
                  value:
                    error: not_found
                    message: Unable to determine status for this domain.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns Details About the Domain.
      tags:
      - Environments
      x-cli-name: environments:domain-status-find
  /environments/{environmentId}/eips:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a list of Web EIPs.
      operationId: getEIPs
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - flags:
                      active: true
                      deprecated: false
                      legacy: false
                    id: f668295f-cbba-472d-8b75-c76ab89e553a
                    ipv4: 203.0.113.1
                    ipv6: 0:0:0:0:0:ffff:cb00:7101
                    status: created
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips
                total: 1
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_eips'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return a List of Web EIPs.
      tags:
      - Environments
      x-cli-name: environments:eips-list
  /environments/{environmentId}/files:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Copies files to this environment.
      operationId: postEnvironmentsFiles
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851
            schema:
              properties:
                source:
                  description: The ID of the environment to copy files from.
                  type: string
              type: object
          application/x-www-form-urlencoded:
            example:
              source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851
            schema:
              properties:
                source:
                  description: The ID of the environment to copy files from.
                  type: string
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Files queued for copying:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/d53fccec-5c1b-4ad4-b431-5cd39ad2b453
                      parent:
                        href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/files
                      self:
                        href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/files
                    message: Copying files.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Missing parameter:
                  value:
                    error: validation_failed
                    message:
                      name: 'Missing required parameter(s): example_param'
                Must be within same application:
                  value:
                    error: validation_failed
                    message:
                      name: Files can only be copied from an environment within the same application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot be copied on Node.js applications:
                  value:
                    error: forbidden
                    message: Files cannot be copied on Node.js applications.
                Cannot be copied on non-hosted applications:
                  value:
                    error: forbidden
                    message: Files cannot be copied on non-hosted applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to copy files to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Cannot be copied to itself:
                  value:
                    error: conflict
                    message: Files cannot be copied from an environment to itself.
                Cannot be copied to production:
                  value:
                    error: conflict
                    message: Files cannot be copied to an environment that is currently in production mode.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Copies Files to This Environment.
      tags:
      - Environments
      x-cli-name: environments:file-copy
  /environments/{environmentId}/livedev/actions/disable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      deprecated: true
      description: Disable Live Development on this environment.
      operationId: postEnvironmentsDisableLiveDev
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              discard: 1
            schema:
              properties:
                discard:
                  description: Indicates whether uncommitted changes should be discarded or not.
                  maximum: 1
                  minimum: 0
                  type: integer
              type: object
          application/x-www-form-urlencoded:
            example:
              discard: 1
            schema:
              properties:
                discard:
                  description: Indicates whether uncommitted changes should be discarded or not.
                  maximum: 1
                  minimum: 0
                  type: integer
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Disabling LiveDev:
                  value:
                    message: Disabling LiveDev.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                LiveDev cannot be disabled on production:
                  value:
                    error: validation_failed
                    message:
                      livedev: LiveDev cannot be disabled on a production environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to disable LiveDev for this environment.
                LiveDev is not available on Node.js applications:
                  value:
                    error: forbidden
                    message: LiveDev is not available on Node.js applications.
                LiveDev is not available on managed applications:
                  value:
                    error: forbidden
                    message: LiveDev is not available for Service Management-enabled applications.
                Only available on hosted applications:
                  value:
                    error: forbidden
                    message: LiveDev is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Cannot be enabled or disabled on production:
                  value:
                    error: validation_failed
                    message: LiveDev cannot be disabled or enabled on a production environment.
                LiveDev already disabled:
                  value:
                    error: validation_failed
                    message: LiveDev is already disabled on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Disable Live Development on This Environment.
      tags:
      - Environments
      x-cli-name: environments:livedev-disable
  /environments/{environmentId}/livedev/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      deprecated: true
      description: Enable Live Development on this environment. Not supported on Acquia Cloud Next.
      operationId: postEnvironmentsEnableLiveDev
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Enabling LiveDev:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5
                      self:
                        href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/livedev/actions/enable
                    message: Enabling LiveDev.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Cannot be enabled on CDE:
                  value:
                    error: validation_failed
                    message:
                      livedev: LiveDev cannot be enabled on a CD environment.
                Cannot be enabled on production:
                  value:
                    error: validation_failed
                    message:
                      livedev: LiveDev cannot be enabled on a production environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot cannot be enabled on Node.js applications:
                  value:
                    error: forbidden
                    message: LiveDev cannot be enabled on Node.js applications.
                Cannot cannot be enabled on managed applications:
                  value:
                    error: forbidden
                    message: LiveDev cannot be enabled for Service Management-enabled applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to enable LiveDev for this environment.
                Only available on hosted applications:
                  value:
                    error: forbidden
                    message: LiveDev cannot be enabled on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                LiveDev already enabled:
                  value:
                    error: validation_failed
                    message: LiveDev is already enabled on this environment.
                LiveDev not supported:
                  value:
                    error: conflict
                    message: LiveDev is not available for Cloud Next environments.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Enable Live Development on This Environment.
      tags:
      - Environments
      x-cli-name: environments:livedev-enable
  /environments/{environmentId}/log-forwarding-destinations:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Returns a collection of log forwarding destinations for this environment.


        Filterable fields:

        * `label`

        * `consumer`


        Sortable fields:

        * `label`

        '
      operationId: getEnvironmentsLogForwardingDestinations
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                      self:
                        href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1
                    address: example.com:1234
                    consumer: sumologic
                    credentials:
                      certificate:
                        certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                        expires_at: '2018-07-16T16:15:33+00:00'
                      key: null
                      token: 204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5
                    environment:
                      id: 123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577
                      name: Test
                    flags:
                      certificate_expiring: false
                      enabled: true
                    health:
                      code: '200'
                      details: Destination OK
                      summary: OK
                    label: Test destination
                    sources:
                    - apache-access
                    - apache-error
                    status: active
                    uuid: df4c5428-8d2e-453d-9edf-e412647449b1
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                      self:
                        href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b5
                    address: 193.169.2.19:5678
                    consumer: syslog
                    credentials:
                      certificate:
                        certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                        expires_at: '2018-07-16T16:15:33+00:00'
                      key: 1d0789d519c0b943cf38f401d30ffbdcd2e0c4cfb7c32ebc0c872bce62aadd4d
                      token: 204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5
                    environment:
                      id: 123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577
                      name: Test
                    flags:
                      certificate_expiring: true
                      enabled: false
                    health:
                      code: '200'
                      details: Destination OK
                      summary: OK
                    label: Another test destination
                    sources:
                    - drupal-request
                    - drupal-watchdog
                    status: active
                    uuid: df4c5428-8d2e-453d-9edf-e412647449b5
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a
                  self:
                    href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/log-forwarding-destinations
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destinations'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view the log forwarding destinations for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a Collection of Log Forwarding Destinations for This Environment.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-list
    post:
      description: Creates a log forwarding destination.
      operationId: postEnvironmentsLogForwardingDestinations
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              address: example.com:1234
              consumer: syslog
              credentials:
                certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
              label: Test destination
              sources:
              - apache-access
              - apache-error
            schema:
              properties:
                address:
                  description: The URL or host name and port of the destination.
                  format: uri
                  type: string
                consumer:
                  description: The application or provider consuming the logs.
                  enum:
                  - loggly
                  - splunk
                  - sumologic
                  - syslog
                  type: string
                credentials:
                  description: Credential information.
                  properties:
                    certificate:
                      description: A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly.
                      type: string
                    key:
                      description: A certificate private key associated with the consumer. Optional for Splunk, Sumologic, and Syslog.  Not supported by Loggly
                      type: string
                    token:
                      description: An API token associated with the consumer. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk.
                      type: string
                  required:
                  - certificate
                  type: object
                label:
                  description: The human-friendly identifier of the destination.
                  type: string
                sources:
                  description: The list of log sources to forward.
                  items:
                    enum:
                    - apache-access
                    - apache-error
                    - varnish-access
                    - drupal-request
                    - drupal-watchdog
                    - php-error
                    - stdout
                    - stderr
                    type: string
                  type: array
              required:
              - label
              - sources
              - consumer
              - credentials
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/bc17cfd2-487b-4e10-b3cf-9fe1f0c10e3f
                  parent:
                    href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/log-forwarding-destinations
                  self:
                    href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/log-forwarding-destinations/95739829-0093-4673-9ee0-5f5bdac04d11
                message: Log forwarding destination for the environment has been created.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Address invalid:
                  value:
                    error: validation_failed
                    message:
                      address: \"invalid-address\" is not a valid address.
                At Log Forwarding destination maximum:
                  value:
                    error: validation_failed
                    message:
                      general: Environments may only have 2 log forwarding destinations.
                Certificate expired:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is expired.
                Certificate expiring:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is expiring. Certificates must be valid for at least 30 days.
                Certificate invalid:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is invalid.
                Certificate not yet active:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is not yet active.
                Consumer not supported:
                  value:
                    error: validation_failed
                    message:
                      consumer: \"invalid-consumer\" is not a supported consumer.
                Log Forwarding not enabled:
                  value:
                    error: validation_failed
                    message:
                      general: Destinations can only be added to environments that have log forwarding enabled.
                Loggly does not support certificate auth:
                  value:
                    error: validation_failed
                    message:
                      credentials: Loggly does not support certificate authentication.
                Loggly does not support custom URLs:
                  value:
                    error: validation_failed
                    message:
                      address: Loggly does not support custom URLs.
                Loggly does not support private key auth:
                  value:
                    error: validation_failed
                    message:
                      credentials: Loggly does not support private key authentication.
                Loggly requires API token:
                  value:
                    error: validation_failed
                    message:
                      credentials: An API token is required for Loggly.
                Source not supported:
                  value:
                    error: validation_failed
                    message:
                      sources: \"invalid-source\" is not a supported source.
                Splunk does not support token auth:
                  value:
                    error: validation_failed
                    message:
                      credentials: Splunk does not support API token authentication.
                Splunk only accepts socket addresses:
                  value:
                    error: validation_failed
                    message:
                      address: Splunk only accepts socket addresses, consisting of a host and port.
                Splunk requires public certificate:
                  value:
                    error: validation_failed
                    message:
                      credentials: A public X.509 certificate is required for Splunk.
                Sumologic only accepts socket addresses:
                  value:
                    error: validation_failed
                    message:
                      address: Sumologic only accepts socket addresses, consisting of a host and port.
                Sumologic requires public certificate:
                  value:
                    error: validation_failed
                    message:
                      credentials: A public X.509 certificate is required for Sumologic.
                Sumologic requires token:
                  value:
                    error: validation_failed
                    message:
                      credentials: An API token is required for Sumologic.
                Syslog only accepts socket addresses:
                  value:
                    error: validation_failed
                    message:
                      address: Syslog only accepts socket addresses, consisting of a host and port.
                Syslog requires public certificate:
                  value:
                    error: validation_failed
                    message:
                      credentials: A public X.509 certificate is required for Syslog.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to create a log forwarding destinations for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Creates a Log Forwarding Destination.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-create
  /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Deletes the specified log forwarding destination.
      operationId: deleteEnvironmentsLogForwardingDestination
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/dfe6afd7-3619-4ab7-8aef-ab26fb506b3a
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                  self:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1
                message: Log forwarding destination has been deleted.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Log Forwarding not enabled:
                  value:
                    error: invalid_operation
                    message:
                      general: Destinations can only be removed from environments that have log forwarding enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to delete the log forwarding destination.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Log Forwarding destination not found on Environment:
                  value:
                    error: invalid_operation
                    message: The environment does not have a log forwarding destination with the UUID 2c15b578-d31a-48ac-ab28-a8ef4c65f02b.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Deletes the Specified Log Forwarding Destination.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-delete
    get:
      description: Returns the specified log forwarding destination.
      operationId: getEnvironmentsLogForwardingDestination
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                  self:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1
                address: example.com:1234
                consumer: syslog
                credentials:
                  certificate:
                    certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    expires_at: '2018-07-16T16:15:33+00:00'
                  key: 1d0789d519c0b943cf38f401d30ffbdcd2e0c4cfb7c32ebc0c872bce62aadd4d
                  token: 204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5
                environment:
                  id: 123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577
                  name: Test
                flags:
                  certificate_expiring: false
                  enabled: true
                health:
                  code: '200'
                  details: Destination OK
                  summary: OK
                label: Test destination
                sources:
                - apache-access
                - apache-error
                status: active
                uuid: df4c5428-8d2e-453d-9edf-e412647449b1
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view the log forwarding destination.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Log Forwarding destination not found:
                  value:
                    error: not_found
                    message: The log forwarding destination you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns the Specified Log Forwarding Destination.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-find
    put:
      description: Updates an environment's log forwarding destination.
      operationId: putEnvironmentsLogForwardingDestination
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid'
      requestBody:
        content:
          application/hal+json:
            example:
              address: example.com:1234
              consumer: syslog
              credentials:
                certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
              label: Test destination
              sources:
              - apache-access
              - apache-error
            schema:
              properties:
                address:
                  description: The URL or host name and port of the destination.
                  format: uri
                  type: string
                consumer:
                  description: The application or provider consuming the logs.
                  enum:
                  - loggly
                  - splunk
                  - sumologic
                  - syslog
                  type: string
                credentials:
                  description: Credential information.
                  properties:
                    certificate:
                      description: A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly.
                      type: string
                    key:
                      description: A certificate private key associated with the consumer. Optional for Splunk, Sumologic, and Syslog.  Not supported by Loggly
                      type: string
                    token:
                      description: An API token associated with the consumer. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk.
                      type: string
                  required:
                  - certificate
                  type: object
                label:
                  description: The human-friendly identifier of the destination.
                  type: string
                sources:
                  description: The list of log sources to forward.
                  items:
                    enum:
                    - apache-access
                    - apache-error
                    - varnish-access
                    - drupal-request
                    - drupal-watchdog
                    - php-error
                    - stdout
                    - stderr
                    type: string
                  type: array
              required:
              - consumer
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/340bf831-5377-49b9-7b26-87014b653346
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                  self:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/cf4c5328-8d2e-353d-9edf-e412647349b1
                message: Log forwarding destination has been updated.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Address invalid:
                  value:
                    error: validation_failed
                    message:
                      address: \"invalid-address\" is not a valid address.
                At Log Forwarding destination maximum:
                  value:
                    error: validation_failed
                    message:
                      general: Environments may only have 2 log forwarding destinations.
                Certificate expired:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is expired.
                Certificate expiring:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is expiring. Certificates must be valid for at least 30 days.
                Certificate invalid:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is invalid.
                Certificate not yet active:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is not yet active.
                Consumer not supported:
                  value:
                    error: validation_failed
                    message:
                      consumer: \"invalid-consumer\" is not a supported consumer.
                Log Forwarding not enabled:
                  value:
                    error: validation_failed
                    message:
                      general: Destinations can only be modified to environments that have log forwarding enabled.
                Loggly does not support certificate auth:
                  value:
                    error: validation_failed
                    message:
                      credentials: Loggly does not support certificate authentication.
                Loggly does not support custom URLs:
                  value:
                    error: validation_failed
                    message:
                      address: Loggly does not support custom URLs.
                Loggly does not support private key auth:
                  value:
                    error: validation_failed
                    message:
                      credentials: Loggly does not support private key authentication.
                Loggly requires API token:
                  value:
                    error: validation_failed
                    message:
                      credentials: An API token is required for Loggly.
                Source not supported:
                  value:
                    error: validation_failed
                    message:
                      sources: \"invalid-source\" is not a supported source.
                Splunk does not support token auth:
                  value:
                    error: validation_failed
                    message:
                      credentials: Splunk does not support API token authentication.
                Splunk only accepts socket addresses:
                  value:
                    error: validation_failed
                    message:
                      address: Splunk only accepts socket addresses, consisting of a host and port.
                Splunk requires public certificate:
                  value:
                    error: validation_failed
                    message:
                      credentials: A public X.509 certificate is required for Splunk.
                Sumologic only accepts socket addresses:
                  value:
                    error: validation_failed
                    message:
                      address: Sumologic only accepts socket addresses, consisting of a host and port.
                Sumologic requires public certificate:
                  value:
                    error: validation_failed
                    message:
                      credentials: A public X.509 certificate is required for Sumologic.
                Sumologic requires token:
                  value:
                    error: validation_failed
                    message:
                      credentials: An API token is required for Sumologic.
                Syslog only accepts socket addresses:
                  value:
                    error: validation_failed
                    message:
                      address: Syslog only accepts socket addresses, consisting of a host and port.
                Syslog requires public certificate:
                  value:
                    error: validation_failed
                    message:
                      credentials: A public X.509 certificate is required for Syslog.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to modify the log forwarding destination.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Log Forwarding destination not found on Environment:
                  value:
                    error: invalid_operation
                    message: The environment does not have a log forwarding destination with the UUID 2c15b578-d31a-48ac-ab28-a8ef4c65f02b.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Updates an Environment's Log Forwarding Destination.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-update
  /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Disables the specified log forwarding destination.
      operationId: postEnvironmentsDisableLogForwardingDestination
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/d1e9dde1-7a60-4f39-951f-295ee7fe343f
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                  self:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1
                message: Log forwarding destination has been disabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Log Forwarding not enabled:
                  value:
                    error: invalid_operation
                    message:
                      general: Destinations can only be disabled on environments that have log forwarding enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to disable this log forwarding destination.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Log Forwarding destination already disabled:
                  value:
                    error: invalid_operation
                    message: The destination is already disabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Disables the Specified Log Forwarding Destination.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-disable
  /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Enables the specified log forwarding destination.
      operationId: postEnvironmentsEnableLogForwardingDestination
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/63a804eb-ad38-4f66-9644-725f0c04e87c
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations
                  self:
                    href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1
                message: Log forwarding destination has been enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Certificate expired:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is expired.
                Certificate expiring:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is expiring. Certificates must be valid for at least 30 days.
                Certificate invalid:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is invalid.
                Certificate not yet active:
                  value:
                    error: validation_failed
                    message:
                      credentials: The certificate is not yet active.
                Log Forwarding not enabled:
                  value:
                    error: invalid_operation
                    message:
                      general: Destinations can only be enabled on environments that have log forwarding enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to enable this log forwarding destination.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Log Forwarding destination not found on Environment:
                  value:
                    error: invalid_operation
                    message: The destination is already enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Enables the Specified Log Forwarding Destination.
      tags:
      - Environments
      x-cli-name: environments:log-forwarding-destination-enable
  /environments/{environmentId}/logs:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a list of log files for this environment available for download.
      operationId: getEnvironmentsLogs
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/apache-access
                    flags:
                      available: false
                    label: Apache access
                    name: apache-access
                    type: apache-access
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/apache-error
                    flags:
                      available: false
                    label: Apache error
                    name: apache-error
                    type: apache-error
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/drupal-request
                    flags:
                      available: false
                    label: Drupal request
                    name: drupal-request
                    type: drupal-request
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/drupal-watchdog
                    flags:
                      available: false
                    label: Drupal watchdog
                    name: drupal-watchdog
                    type: drupal-watchdog
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/fpm-access
                    flags:
                      available: false
                    label: Fpm access
                    name: fpm-access
                    type: fpm-access
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/fpm-error
                    flags:
                      available: false
                    label: Fpm error
                    name: fpm-error
                    type: fpm-error
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/php-error
                    flags:
                      available: false
                    label: PHP error
                    name: php-error
                    type: php-error
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/cloud-hook
                    flags:
                      available: false
                    label: Cloud hook
                    name: cloud-hook
                    type: cloud-hook
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/cronjob
                    flags:
                      available: false
                    label: Cronjob
                    name: cronjob
                    type: cronjob
                  - _links:
                      download:
                        href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/mysql-slow-query
                    flags:
                      available: true
                    label: MySQL slow query
                    name: mysql-slow-query
                    type: mysql-slow-query
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851
                  self:
                    href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs
                total: 6
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_logs'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Logs cannot be accessed on non-hosted environments.
                Not found:
                  value:
                    error: not_found
                    message: The application you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a List of Log Files for This Environment Available for Download.
      tags:
      - Environments
      x-cli-name: environments:log-list
  /environments/{environmentId}/logs/{logType}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Downloads the log file.
      operationId: getEnvironmentsLog
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-type'
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                File download:
                  value:
                    expires_at: '2019-11-30T23:21:02+00:00'
                    url: http://appsiteenv.host.site-example.com/AH_DOWNLOAD?d=/mnt/gfs/appsiteenv/logs/log_type_log_appsiteenv_1574901901.sql&t=157492&env=fecac803549db0072661378f0f
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file-download'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file'
            text/html:
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file-download'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to download logs for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Cannot be downloaded on non-hosted applications:
                  value:
                    error: not_found
                    message: Logs cannot be downloaded on non-hosted environments.
                Does not exist:
                  value:
                    error: not_found
                    message: The file you are trying to access does not exist.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Downloads the Log File.
      tags:
      - Environments
      x-cli-name: environments:log-download
    post:
      description: Creates a log file snapshot.
      operationId: postEnvironmentsLog
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-type'
      requestBody:
        content:
          application/hal+json:
            example:
              from: '2021-01-28T22:45:21+00:00'
              to: '2021-01-29T23:55:21+00:00'
            schema:
              properties:
                from:
                  description: An ISO-8601 formatted date retrieve results from. Date ranges are only supported on Acquia Cloud Next.
                  type: string
                to:
                  description: An ISO-8601 formatted date retrieve results to. Date ranges are only supported on Acquia Cloud Next.
                  type: string
              type: object
        required: false
      responses:
        '201':
          content:
            application/hal+json:
              examples:
                Is being created:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/8b790313-8830-4810-baef-3b41b3786e9d
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/logs
                      self:
                        href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/logs/apache-access
                    message: The log file is being created.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Created
        '400':
          content:
            application/hal+json:
              examples:
                Invalid range:
                  value:
                    error: validation_failed
                    message:
                      general: Log snapshots must cover no more than 24 hours and can only be retrieved up to 30 days in the past.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to download logs for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Cannot be accessed on non-hosted applications:
                  value:
                    error: not_found
                    message: Logs cannot be accessed on non-hosted environments.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Date range not supported:
                  value:
                    error: conflict
                    message: Date ranges for log file snapshots are not supported on this environment.
                Log snapshot not supported:
                  value:
                    error: conflict
                    message: Log snapshots are not supported on this environment.
                Log type not supported:
                  value:
                    error: conflict
                    message: Log file snapshot for mysql-slow-query is not available on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Creates a Log File Snapshot.
      tags:
      - Environments
      x-cli-name: environments:log-create
  /environments/{environmentId}/logstream:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a logstream url and metadata.
      operationId: getEnvironmentsLogstream
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851
                  self:
                    href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logstream
                  wss:
                    href: wss://logstream.example.com/ah_websocket/logstream/v1
                logstream:
                  commands:
                  - stream-environment
                  - enable
                  - disable
                  params:
                    environment: prod
                    hmac: d8b940bb5a1865e57b22734d541ed981c89f952e527b0a983d0e457437a43c23
                    site: clouduidev:qa4
                    t: 1516990002
                  url: wss://logstream.example.com/ah_websocket/logstream/v1
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_logstream'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Do not exist on non-hosted applications:
                  value:
                    error: not_found
                    message: Logs cannot be accessed on non-hosted environments.
                Not found:
                  value:
                    error: not_found
                    message: The application you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a Logstream Url and Metadata.
      tags:
      - Environments
      x-cli-name: environments:logstream-find
  /environments/{environmentId}/metrics:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Does not return any data. Allows traversal to metrics groups endpoints.
      operationId: getEnvironmentsMetrics
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a
                  self:
                    href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics
                  stackmetrics:
                    href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_metrics'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Not available on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: Metrics are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Does Not Return Any Data. Allows Traversal to Metrics Groups Endpoints.
      tags:
      - Environments
      x-cli-name: environments:metrics
  /environments/{environmentId}/metrics/stackmetrics:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Does not return any data. Allows traversal to StackMetrics endpoints.
      operationId: getEnvironmentsStackMetrics
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  data:
                    href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics/data
                  parent:
                    href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics
                  self:
                    href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_metrics'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Not available on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: Metrics are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Does Not Return Any Data. Allows Traversal to StackMetrics Endpoints.
      tags:
      - Environments
      x-cli-name: environments:stack-metrics-data-list
  /environments/{environmentId}/metrics/stackmetrics/data:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns StackMetrics data for the metrics specified by the filter paramater (e.g., apache-access, web-cpu).
      operationId: getEnvironmentsStackMetricsData
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-stack-metrics'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from-stack-metrics'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to-no-default'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - datapoints:
                    - - '2.5395360194838'
                      - '1447876380'
                    - - '3.3012513318685'
                      - '1447876680'
                    - - '4.568567607842'
                      - '1447876980'
                    last_data_at: '2019-06-19T00:00:00+00:00'
                    metadata:
                      host: fsdb-1.prod.hosting.acquia.com
                    metric: db-cpu
                  - datapoints:
                    - - '22.1395360194838'
                      - '1447876380'
                    - - '23.7012513318685'
                      - '1447876680'
                    - - '24.168567607842'
                      - '1447876980'
                    last_data_at: '2019-06-19T00:00:00+00:00'
                    metadata:
                      host: fsdb-2.prod.hosting.acquia.com
                    metric: db-cpu
                  - datapoints:
                    - - '12.1395360194838'
                      - '1447876380'
                    - - '12.7012513318685'
                      - '1447876680'
                    - - '12.168567607842'
                      - '1447876980'
                    last_data_at: '2019-06-19T00:00:00+00:00'
                    metadata:
                      host: web-1.prod.hosting.acquia.com
                    metric: web-cpu
                  - datapoints:
                    - - '2.1395360194838'
                      - '1447876380'
                    - - '2.7012513318685'
                      - '1447876680'
                    - - '2.168567607842'
                      - '1447876980'
                    last_data_at: '2019-06-19T00:00:00+00:00'
                    metadata:
                      host: web-2.prod.hosting.acquia.com
                    metric: web-cpu
                _links:
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/metrics/stackmetrics/data?filter=metric=db-cpu,metric=web-cpu&from=2019-06-20
                total: 4
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_stack-metrics-data'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Not available on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: Metrics are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns StackMetrics Data for the Metrics Specified in the Filter Paramater (e.g., Apache-access, Web-cpu).
      tags:
      - Environments
      x-cli-name: environments:stack-metrics-data-find
  /environments/{environmentId}/metrics/usage:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Retrieves traversal links for an environment's usage data.
      operationId: getEnvironmentsUsageLinks
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  data:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics
                  self:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
                  views:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
                  visits:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_usage'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view usage metrics for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Retrieves Traversal Links for an Environment's Usage Data.
      tags:
      - Environments
      x-cli-name: environments:usage-links
  /environments/{environmentId}/metrics/usage/data:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Filterable fields:

        * `metric` - One of: {`views`, `visits`}

        '
      operationId: getEnvironmentsUsageData
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
                      self:
                        href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
                    datapoints:
                    - - '2019-03-13T00:00:00+00:00'
                      - '9'
                    - - '2019-03-14T00:00:00+00:00'
                      - '1'
                    last_data_at: '2019-03-14T00:00:00+00:00'
                    metadata:
                      application:
                        uuids:
                        - 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
                      environment:
                        ids:
                        - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
                      subscription:
                        uuids:
                        - 9567a611-4cdd-4586-8b3f-f3980a87e471
                    metric: views
                  - _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
                      self:
                        href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
                    datapoints:
                    - - '2019-03-13T00:00:00+00:00'
                      - '3'
                    - - '2019-03-14T00:00:00+00:00'
                      - '1'
                    last_data_at: '2019-03-14T00:00:00+00:00'
                    metadata:
                      application:
                        uuids:
                        - 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
                      environment:
                        ids:
                        - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
                      subscription:
                        uuids:
                        - 9567a611-4cdd-4586-8b3f-f3980a87e471
                    metric: visits
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
                  self:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-usage-metrics'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view usage metrics for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Retrieves Usage Data for an Environment.
      tags:
      - Environments
      x-cli-name: environments:usage-data
  /environments/{environmentId}/metrics/usage/{usageMetric}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Retrieves usage metric data for an environment.
      operationId: getEnvironmentsUsageMetricData
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_usage-metric'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
                  self:
                    href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
                datapoints:
                - - '2019-03-13T00:00:00+00:00'
                  - '9'
                - - '2019-03-14T00:00:00+00:00'
                  - '1'
                last_data_at: '2019-03-14T00:00:00+00:00'
                metadata:
                  application:
                    uuids:
                    - 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
                  environment:
                    ids:
                    - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
                  subscription:
                    uuids:
                    - 9567a611-4cdd-4586-8b3f-f3980a87e471
                metric: views
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-usage-metric'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view pricing metric data.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Data not found:
                  value:
                    error: not_found
                    message: Pricing metric data for the environment with ID @id cannot be found, or you do not have access to it.
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Retrieves Usage Metric Data for an Environment.
      tags:
      - Environments
      x-cli-name: environments:usage-metric-data
  /environments/{environmentId}/mod-proxy:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns the mod proxy status for an Environment.
      operationId: getModProxyStatus
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-eba23ecc-aa7c-41b0-8aa4-9d7ef250357d
                  self:
                    href: https://cloud.acquia.com/api/environments/24-eba23ecc-aa7c-41b0-8aa4-9d7ef250357d/mod-proxy
                status: active
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_mod-proxy'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: conflict
                    message: Mod proxy configuration is not available for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not available
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns the Mod Proxy Status for an Environment.
      tags:
      - Environments
      x-cli-name: environments:mod-proxy-status
  /environments/{environmentId}/mod-proxy/actions/disable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Disables mod proxy for an environment.
      operationId: postDisableModProxy
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '202':
          content:
            application/json:
              example:
                _links:
                  self:
                    href: https://cloud.acquia.com/api/environments/12-5ee5d7be-ec42-4ea3-9d98-1363dcfacfd23/mod-proxy/actions/disable
                message: Mod proxy is being disabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to disable mod proxy for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/json:
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: conflict
                    message: Mod proxy configuration is not available for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not available
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Disables Mod Proxy for an Environment.
      tags:
      - Environments
      x-cli-name: environments:mod-proxy-disable
  /environments/{environmentId}/mod-proxy/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Enables mod proxy for an environment.
      operationId: postEnableModProxy
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '202':
          content:
            application/json:
              example:
                _links:
                  self:
                    href: https://cloud.acquia.com/api/environments/12-5ee5d7be-ec42-4ea3-9d98-1363dcfacfd23/mod-proxy/actions/enable
                message: Mod proxy is being enabled.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to enable mod proxy for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/json:
              examples:
                No subscription or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: conflict
                    message: Mod proxy configuration is not available for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not available
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Enables Mod Proxy for an Environment.
      tags:
      - Environments
      x-cli-name: environments:mod-proxy-enable
  /environments/{environmentId}/operating-systems:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns a list of operating systems.
      operationId: getOperatingSystems
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93
                  self:
                    href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/operating-systems
                versions:
                - available: true
                  label: Ubuntu 16.04 (Xenial Xerus)
                  name: xenial
                  version: 16.0.4
                - available: true
                  label: Ubuntu 20.04 (Focal Fossa)
                  name: focal
                  version: '20.04'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_operating-systems'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The operating systems you are trying to access do not exist, or you do not have permission to access them.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return a List of Operating Systems.
      tags:
      - Environments
      x-cli-name: environments:operating-systems-list
  /environments/{environmentId}/production-mode/actions/disable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Removes protection from a production environment, taking it out of production mode.
      operationId: postEnvironmentsDisableProductionMode
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Production mode disabled:
                  value:
                    message: Production mode has been disabled for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Only production can be unprotected:
                  value:
                    error: validation_failed
                    message:
                      productionmode: Only production environments can be unprotected.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot cannot be disabled on Node.js applications:
                  value:
                    error: forbidden
                    message: Production mode is not available on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to disable Production mode for this environment.
                Only available on hosted applications:
                  value:
                    error: forbidden
                    message: Production mode is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not in production mode:
                  value:
                    error: conflict
                    message: This environment is not currently in production mode.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Disables Production Mode for an Environment.
      tags:
      - Environments
      x-cli-name: environments:production-mode-disable
  /environments/{environmentId}/production-mode/actions/enable:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Enables production mode for an environment. While production mode is enabled, files and databases cannot be copied to the production environment.
      operationId: postEnvironmentsEnableProductionMode
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Production mode enabled:
                  value:
                    message: Production mode has been enabled for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Only production can be protected:
                  value:
                    error: validation_failed
                    message:
                      productionmode: Only production environments can be protected.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot cannot be enabled on Node.js applications:
                  value:
                    error: forbidden
                    message: Production mode cannot be enabled on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to enable Production mode for this environment.
                Only available on hosted applications:
                  value:
                    error: forbidden
                    message: Production mode is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Already in production mode:
                  value:
                    error: conflict
                    message: This environment is already in production mode.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Enables Production Mode for an Environment.
      tags:
      - Environments
      x-cli-name: environments:production-mode-enable
  /environments/{environmentId}/search:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Does not return any data. Allows traversal to search entity endpoints.
      operationId: getEnvironmentSearchList
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  indexes:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905
                  self:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_search'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Forbidden:
                  value:
                    error: forbidden
                    message: You do not have permission to manage search for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns a Traversal Endpoint for Search Entities for the Environment.
      tags:
      - Environments
      x-cli-name: environments:search:list
  /environments/{environmentId}/search/indexes:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: A collection of search indexes for an environment.
      operationId: getEnvironmentSearchIndexes
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _embedded:
                      configuration_set:
                        _links:
                          parent:
                            href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
                          self:
                            href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121
                        application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
                        flags:
                          custom: false
                        id: shared-1234567891011-121
                        label: example-0
                        status: active
                    _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes
                      self:
                        href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example
                    config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
                    database_role: example
                    environment_id: 123-3f6d06a9-9236-411e-9dcc-44f0003a5905
                    id: ABCDE-1234.test.example
                    solr_version: '7'
                    status: active
                    url: https://example.com/solr/ABCDE-1234.test.example/
                  - _embedded:
                      configuration_set:
                        _links:
                          parent:
                            href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
                          self:
                            href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
                        application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
                        flags:
                          custom: true
                        id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
                        label: example-1
                        status: pending
                    _links:
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes
                      self:
                        href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1235.test.example
                    config_set_id: ABCD5-1234.12345ab6c7e8f90g12i1jk234l56mn78
                    database_role: example
                    environment_id: 123-3f6d06a9-9236-411e-9dcc-44f0003a5905
                    id: ABCDE-1235.test.example
                    solr_version: '7'
                    status: active
                    url: https://example.com/solr/ABCDE-1235.test.example/
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?filter}
                    templated: true
                  limit:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?limit}
                    templated: true
                  offset:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?offset}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search
                  self:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes
                  sort:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?sort}
                    templated: true
                pagination:
                  limit: 0
                  offset: 0
                  total: 2
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_indexes'
          description: OK
        '403':
          content:
            application/hal+json:
              example:
                error: forbidden
                message: You do not have permission to view the search indexes on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              example:
                error: not_found
                message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns a Collection of Search Indexes for an Environment.
      tags:
      - Environments
      x-cli-name: environments:search:indexes-list
    post:
      description: Creates a search index for an environment.
      operationId: postEnvironmentSearchIndexes
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
              database_role: example
            schema:
              properties:
                config_set_id:
                  description: A configuration set ID to assign to the index.
                  type: string
                database_role:
                  description: The database role for the search index.
                  type: string
              required:
              - database_role
              type: object
          application/x-www-form-urlencoded:
            example:
              config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
              database_role: example
            schema:
              properties:
                config_set_id:
                  description: A configuration set ID to assign to the index.
                  type: string
                database_role:
                  description: The database role for the search index.
                  type: string
              required:
              - database_role
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/5494cbe6-fe98-4cfa-877b-05bab3be3bf8
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/
                  self:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example
                message: The search index for example is being created.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              example:
                error: forbidden
                message: You do not have permission to create search configuration sets on this application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Configuration set not found or not enough permission:
                  value:
                    error: not_found
                    message: The configuration set you are trying to access does not exist, or you do not have permission to access it.
                Environment not found or not enough permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Configuration set not available:
                  value:
                    error: validation_failed
                    message: The configuration set is not available for this environment.
                Database does not exist:
                  value:
                    error: validation_failed
                    message: The database does not exist in this environment.
                Search index already available:
                  value:
                    error: validation_failed
                    message: The search index is already available for this environment.
                Search not available:
                  value:
                    error: validation_failed
                    message: Acquia Search is not available for this subscription.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Creates a Search Index for an Environment.
      tags:
      - Environments
      x-cli-name: environments:search:index-create
  /environments/{environmentId}/search/indexes/{indexId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Removes and deletes a specific search index from an environment
      operationId: deleteEnvironmentSearchIndex
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_index-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/d64552a2-7e3e-46af-b2a0-b122aae26a7d
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/
                  self:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example
                message: The search index has been removed from the environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              example:
                error: forbidden
                message: You do not have permission to delete search indexes on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                No application or not enough permissions:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Search index not available:
                  value:
                    error: not_found
                    message: The search index is not available to this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              example:
                error: validation_failed
                message: Acquia Search is not available for this subscription.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Removes and Deletes a Specific Search Index from an Environment
      tags:
      - Environments
      x-cli-name: environments:search:index-delete
    get:
      description: A specific search configuration set.
      operationId: getEnvironmentSearchIndex
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_index-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  configuration_set:
                    _links:
                      parent:
                        href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
                      self:
                        href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
                    application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
                    flags:
                      custom: true
                    id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
                    label: example-1
                    status: pending
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes
                  self:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example
                config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
                database_role: example
                environment_id: 123-3f6d06a9-9236-411e-9dcc-44f0003a5905
                health:
                  code: OK
                  details: No issues.
                  summary: Search index active
                id: ABCDE-1234.test.example
                solr_version: '7'
                status: active
                url: https://example.com/solr/ABCDE-1234.test.example/
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_index'
          description: OK
        '403':
          content:
            application/hal+json:
              example:
                error: forbidden
                message: You do not have permission to view the search indexes on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                No environment or not enough permissions:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                No index or not enough permissions:
                  value:
                    error: not_found
                    message: The search index you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns a Search Configuration Set for an Application
      tags:
      - Environments
      x-cli-name: environments:search:index-find
    put:
      description: Updates a search index on an environment.
      operationId: putEnvironmentSearchIndex
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_index-id'
      requestBody:
        content:
          application/hal+json:
            example:
              config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
            schema:
              properties:
                config_set_id:
                  description: The configuration set ID to update to.
                  type: string
              type: object
          application/x-www-form-urlencoded:
            example:
              config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
            schema:
              properties:
                config_set_id:
                  description: The configuration set ID to update to.
                  type: string
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/a0733378-eee4-4c29-bc2d-dea85e17b1aa
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/
                  self:
                    href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example
                message: The search index ABCDE-1234.test.example is being updated.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: OK
        '403':
          content:
            application/hal+json:
              example:
                error: forbidden
                message: You do not have permission to make a change in a search index on this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              example:
                error: not_found
                message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Configuration set not available:
                  value:
                    error: conflict
                    message: The configuration set is not available for this environment.
                Search not available:
                  value:
                    error: conflict
                    message: Acquia Search is not available for this subscription.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Updates a Search Index on an Environment.
      tags:
      - Environments
      x-cli-name: environments:search:index-update
  /environments/{environmentId}/servers:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Returns a list of servers.


        Filterable fields:

        * `name`

        * `region`

        * `hostname`

        * `ip`

        * `status`


        Sortable fields:

        * `name`

        * `region`

        * `hostname`

        * `ip`

        * `status`

        '
      operationId: getEnvironmentsServers
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/6
                    ami_type: c1.medium
                    configuration:
                      ecu: 5
                      memcache: 64
                      memory: 1.7
                    environment:
                      id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      active_bal: false
                      active_web: true
                      balancer: false
                      database: true
                      dedicated: false
                      elastic_ip: false
                      fs: false
                      memcache: true
                      primary_db: true
                      self_service: false
                      web: true
                    hostname: ded-6.servers.acquia.com
                    id: 6
                    ip: 10.0.0.1
                    name: ded-6
                    operating_system: xenial
                    region: us-west-1
                    roles:
                    - web
                    - db
                    ssh_user: user.dev
                    status: normal
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/4
                    ami_type: m1.small
                    configuration:
                      ecu: 1
                      memcache: null
                      memory: 1.7
                    environment:
                      id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                      name: dev
                    flags:
                      active_bal: false
                      active_web: false
                      balancer: true
                      database: false
                      dedicated: true
                      elastic_ip: false
                      fs: false
                      memcache: false
                      primary_db: true
                      self_service: false
                      web: false
                    hostname: bal-4.servers.acquia.com
                    id: 4
                    ip: 10.0.0.2
                    name: bal-4
                    operating_system: xenial
                    region: us-west-1
                    roles:
                    - bal
                    ssh_user: user.dev
                    status: normal
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_servers'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Cannot be viewed for CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be viewed for CD environments.
                Cannot be viewed for managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be viewed for Service Management-enabled applications.
                Cannot be viewed on Node.js applications:
                  value:
                    error: not_available
                    message: Servers cannot be viewed on Node.js applications.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Servers are not available on non-hosted applications.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns a List of Servers.
      tags:
      - Environments
      x-cli-name: environments:servers-list
  /environments/{environmentId}/servers/{serverId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Return details about a specific server.
      operationId: getEnvironmentsServer
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  self:
                    href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/6
                ami_type: c1.medium
                configuration:
                  ecu: 5
                  memcache: 64
                  memory: 1.7
                environment:
                  id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
                  name: dev
                flags:
                  active_bal: false
                  active_web: true
                  balancer: false
                  database: true
                  dedicated: false
                  elastic_ip: false
                  fs: false
                  memcache: true
                  primary_db: true
                  self_service: false
                  web: true
                hostname: ded-6.servers.acquia.com
                id: 6
                ip: 10.0.0.1
                name: ded-6
                operating_system: xenial
                region: us-west-1
                roles:
                - web
                - db
                ssh_user: user.dev
                status: normal
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Cannot be viewed for CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be viewed for CD environments.
                Cannot be viewed for managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be viewed for Service Management-enabled applications.
                Cannot be viewed on Node.js applications:
                  value:
                    error: not_available
                    message: Servers cannot be viewed on Node.js applications.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Servers are not available on non-hosted applications.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Return Details About a Specific Server.
      tags:
      - Environments
      x-cli-name: environments:server-find
    put:
      description: Modifies configuration settings for a server.
      operationId: putEnvironmentsServer
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
      requestBody:
        content:
          application/hal+json:
            example:
              memcache: 128
            schema:
              properties:
                memcache:
                  default: 64
                  description: The size (in MB) of memcache on this server.
                  minimum: 0
                  type: integer
              type: object
          application/x-www-form-urlencoded:
            example:
              memcache: 128
            schema:
              properties:
                memcache:
                  default: 64
                  description: The size (in MB) of memcache on this server.
                  minimum: 0
                  type: integer
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Server configuration being updated:
                  value:
                    message: The server configuration is being updated.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                No options set to update:
                  value:
                    error: validation_failed
                    message:
                      general: No configuration options were set to update. No action performed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Cannot be configured for free tier:
                  value:
                    error: forbidden
                    message: Configuration cannot be modified for this application.
                Cannot be configured on Node.js applications:
                  value:
                    error: not_available
                    message: Server configuration cannot be modified on Node.js applications.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to configure this server.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Servers are not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Cannot be configured for CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be configured for CD environments.
                Cannot be configured for managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be configured for Service Management-enabled applications.
                Not found:
                  value:
                    error: not_found
                    message: The application you are trying to access does not exist, or you do not have permission to access it.
                Server not found in application:
                  value:
                    error: not_found
                    message: The server with ID 42 does not exist in this application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Modifies Configuration Settings for a Server.
      tags:
      - Environments
      x-cli-name: environments:server-update
  /environments/{environmentId}/servers/{serverId}/actions/reboot:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Reboots a server. This will cause all applications on this server to be unavailable while the server reboots.
      operationId: postEnvironmentsServerReboot
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Server is being rebooted:
                  value:
                    message: The server is being rebooted.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                CDEs cannot be rebooted:
                  value:
                    error: validation_failed
                    message:
                      general: CD environments cannot be rebooted.
                Only Acquia Cloud Professional can be rebooted:
                  value:
                    error: validation_failed
                    message:
                      general: Servers belonging to subscriptions that are not Acquia Cloud Professional cannot be manually rebooted.
                Only self-service can be rebooted:
                  value:
                    error: validation_failed
                    message:
                      general: Only self-service servers can be manually rebooted.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to reboot this server.
                Not available on Node.js applications:
                  value:
                    error: not_available
                    message: Servers cannot be rebooted on Node.js applications.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be rebooted for Service Management-enabled applications.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Rebooting a server is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Not available on CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be rebooted for CD environments.
                Server not found:
                  value:
                    error: not_found
                    message: The server you are trying to access does not exist, or you do not have permission to access it.
                Server not found in application:
                  value:
                    error: not_found
                    message: The server with ID 42 does not exist in this application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Reboots a Server.
      tags:
      - Environments
      x-cli-name: environments:server-reboot
  /environments/{environmentId}/servers/{serverId}/actions/relaunch:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Relaunches a server. This will cause all applications on this server to be unavailable while the server relaunches.
      operationId: postEnvironmentsServerRelaunch
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Server is being relaunched:
                  value:
                    message: The server is being relaunched.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                CDEs cannot be relaunched:
                  value:
                    error: validation_failed
                    message:
                      general: CD environments cannot be relaunched.
                Only Acquia Cloud Professional can be relaunched:
                  value:
                    error: validation_failed
                    message:
                      general: Servers belonging to subscriptions that are not Acquia Cloud Professional cannot be manually relaunched.
                Only self-service can be relaunched:
                  value:
                    error: validation_failed
                    message:
                      general: Only self-service servers can be manually relaunched.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to relaunch this server.
                Not available on Node.js applications:
                  value:
                    error: not_available
                    message: Servers cannot be relaunched on Node.js applications.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be relaunched for Service Management-enabled applications.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Relaunching servers is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Not available on CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be relaunched for CD environments.
                Server not found:
                  value:
                    error: not_found
                    message: The server you are trying to access does not exist, or you do not have permission to access it.
                Server not found in application:
                  value:
                    error: not_found
                    message: The server with ID 42 does not exist in this application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Relaunches a Server.
      tags:
      - Environments
      x-cli-name: environments:server-relaunch
  /environments/{environmentId}/servers/{serverId}/actions/suspend:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Suspends a server. The server will no longer respond to web requests.
      operationId: postEnvironmentsServerSuspend
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Server is being suspended:
                  value:
                    message: The server is being suspended.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                CDEs cannot be suspended:
                  value:
                    error: validation_failed
                    message:
                      general: CD environments cannot be suspended.
                Only Acquia Cloud Professional can be suspended:
                  value:
                    error: validation_failed
                    message:
                      general: Servers belonging to subscriptions that are not Acquia Cloud Professional cannot be manually suspended.
                Only self-service can be suspended:
                  value:
                    error: validation_failed
                    message:
                      general: Only self-service servers can be manually suspended.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to suspend this server.
                Not available on Node.js applications:
                  value:
                    error: not_available
                    message: Servers cannot be suspended on Node.js applications.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be suspended for Service Management-enabled applications.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Suspending servers is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Not available on CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be suspended for CD environments.
                Server not found:
                  value:
                    error: not_found
                    message: The server you are trying to access does not exist, or you do not have permission to access it.
                Server not found in application:
                  value:
                    error: not_found
                    message: The server with ID 42 does not exist in this application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Suspends a Server.
      tags:
      - Environments
      x-cli-name: environments:server-suspend
  /environments/{environmentId}/servers/{serverId}/actions/upgrade:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Upgrades a server from "precise" to "xenial".
      operationId: postEnvironmentsServerUpgrade
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Server is being upgraded:
                  value:
                    message: The server is being upgraded.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                CDEs cannot be upgraded:
                  value:
                    error: validation_failed
                    message:
                      general: CD environments cannot be upgraded.
                Can only be upgraded from "precise":
                  value:
                    error: validation_failed
                    message:
                      general: Only servers running "precise" may be upgraded.
                Only Acquia Cloud Professional can be upgraded:
                  value:
                    error: validation_failed
                    message:
                      general: Servers belonging to subscriptions that are not Acquia Cloud Professional cannot be manually upgraded.
                Only self-service can be upgraded:
                  value:
                    error: validation_failed
                    message:
                      general: Only self-service servers can be manually upgraded.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to upgrade this server.
                Not available on Node.js applications:
                  value:
                    error: not_available
                    message: Servers cannot be upgraded on Node.js applications.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Servers cannot be upgraded for Service Management-enabled applications.
                Not available on non-hosted applications:
                  value:
                    error: not_found
                    message: Upgrading servers is not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Not available on CDEs:
                  value:
                    error: not_available
                    message: Servers cannot be upgraded for CD environments.
                Server not found:
                  value:
                    error: not_found
                    message: The server you are trying to access does not exist, or you do not have permission to access it.
                Server not found in application:
                  value:
                    error: not_found
                    message: The server with ID 42 does not exist in this application.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Upgrades a Server from "precise" to "xenial".
      tags:
      - Environments
      x-cli-name: environments:server-upgrade
  /environments/{environmentId}/settings:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Provides links to environment settings.
      operationId: getEnvironmentsSettings
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  apm:
                    href: https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123/settings/apm
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123
                  self:
                    href: https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123/settings
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-settings'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Provides Links to Environment Settings.
      tags:
      - Environments
      x-cli-name: environments:settings
  /environments/{environmentId}/ssl:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns the SSL settings for this environment.
      operationId: getSsl
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  certificates:
                    href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl/certificates
                  csrs:
                    href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl/csrs
                  parent:
                    href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2
                  self:
                    href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl
                balancer:
                  hostname: example.us-east-1.elb.amazonaws.com
                ips:
                - 127.0.0.1
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssl'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Not available for free tier:
                  value:
                    error: not_found
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns the SSL Settings for This Environment.
      tags:
      - Environments
      x-cli-name: environments:ssl-settings-find
  /environments/{environmentId}/ssl/certificates:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns the SSL certificates that are installed on this environment.
      operationId: getCertificates
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      csr:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/7
                      self:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/7
                    ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    domains:
                    - example.com
                    - www.example.com
                    environment:
                      id: 5-a1a10dab-62f4-418c-bc58-ab7742078ba8
                      name: prod
                    expires_at: 2022-03-28T00:12:34-0400
                    flags:
                      active: true
                      csr: true
                      legacy: true
                    id: 7
                    label: null
                    private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/3
                    ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    domains:
                    - example2.com
                    - www.example2.com
                    environment:
                      id: 5-a1a10dab-62f4-418c-bc58-ab7742078ba8
                      name: prod
                    expires_at: 2021-01-01T00:00:00-0400
                    flags:
                      active: true
                      csr: false
                      legacy: false
                    id: 3
                    label: Test Certificate 1
                    private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/4
                    ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                    domains:
                    - example3.com
                    - www.example3.com
                    environment:
                      id: 5-a1a10dab-62f4-418c-bc58-ab7742078ba8
                      name: prod
                    expires_at: 2021-01-01T00:00:00-0400
                    flags:
                      active: false
                      csr: true
                      legacy: false
                    id: 4
                    label: Test Certificate 2
                    private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl
                  self:
                    href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates
                total: 3
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificates'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Non-hosted application:
                  value:
                    error: not_found
                    message: SSL Certificates are not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Return a List of SSL Certificates.
      tags:
      - Environments
      x-cli-name: environments:certificate-list
    post:
      description: Install a new SSL certificate on this environment.
      operationId: postCertificate
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              ca_certificates: '-----BEGIN CERTIFICATE-----123abc....-----END CERTIFICATE-----'
              certificate: '-----BEGIN CERTIFICATE-----abc123....-----END CERTIFICATE-----'
              csr_id: 123
              label: My New Cert
              legacy: false
              private_key: '-----BEGIN RSA PRIVATE KEY-----secret....-----END RSA PRIVATE KEY-----'
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-certificate'
          application/x-www-form-urlencoded:
            example:
              ca_certificates: '-----BEGIN CERTIFICATE-----123abc....-----END CERTIFICATE-----'
              certificate: '-----BEGIN CERTIFICATE-----abc123....-----END CERTIFICATE-----'
              csr_id: 123
              label: My New Cert
              legacy: false
              private_key: '-----BEGIN RSA PRIVATE KEY-----secret....-----END RSA PRIVATE KEY-----'
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-certificate'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Site is being imported:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/8fdacf25-38e4-4621-b5de-e78638fe2ceb
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl
                      self:
                        href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl/certificates
                    message: Installing the certificate.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Cannot install:
                  value:
                    error: system
                    message: Unable to install a certificate on environment ID 5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4. Site certificate CA chain certificates are out of order or contain unused certificates.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage SSL certificates on this environment.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: SSL certificates cannot be managed on non-hosted applications.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Invalid country code:
                  value:
                    error: validation_failed
                    message:
                      general: Invalid country code. Country codes should be alphabetic and less than 2 characters long.
                Invalid domain:
                  value:
                    error: validation_failed
                    message:
                      domain: The domain invalid does not appear to be a valid domain name.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Install an SSL Certificate.
      tags:
      - Environments
      x-cli-name: environments:certificate-create
  /environments/{environmentId}/ssl/certificates/{certificateId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Deletes a specific certificate by its ID.
      operationId: deleteCertificate
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/767cee8d-05f6-4761-a3dc-755957dfc9e6
                  parent:
                    href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates
                  self:
                    href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/9
                message: Deleting the certificate.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to delete SSL certificates on this environment.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: SSL certificates are not available on non-hosted applications.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Incorrect certificate:
                  value:
                    error: not_found
                    message: This certificate does not belong to the environment, and cannot be removed.
                No environment or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not on Acquia Cloud Free:
                  value:
                    error: validation_failed
                    message:
                      general: The currently active certificate cannot be removed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deletes a Specific Certificate by its ID.
      tags:
      - Environments
      x-cli-name: environments:certificate-delete
    get:
      description: Returns details about a specific SSL certificate.
      operationId: getCertificate
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4/ssl/certificates
                  self:
                    href: https://cloud.acquia.com/api/environments/5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4/ssl/certificates/13
                ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
                domains:
                - example.com
                - www.example.com
                environment:
                  id: 5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4
                  name: prod
                expires_at: 2022-03-28T00:12:34-0400
                flags:
                  active: true
                  csr: true
                  legacy: false
                id: 13
                label: Test Certificate
                private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificate'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Non-hosted application:
                  value:
                    error: not_found
                    message: SSL certificates are not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns a Specific Certificate by Certificate Id.
      tags:
      - Environments
      x-cli-name: environments:certificate-find
  /environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Activates an SSL certificate.
      operationId: postActivateCertificate
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/4ee513c7-13b4-459f-af60-ba50c4f7cb5d
                  self:
                    href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/1/actions/activate
                message: Activating the certificate.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Cannot be installed on CD environments:
                  value:
                    error: validation_failed
                    message:
                      general: Legacy certificates cannot be installed on CD environments.
                Invalid private key:
                  value:
                    error: validation_failed
                    message:
                      private_key: The supplied private key is invalid.
                Legacy cannot be installed using non-legacy:
                  value:
                    error: validation_failed
                    message:
                      csr_id: A legacy certificate cannot be installed using a non-legacy certificate signing request.
                Name already exists:
                  value:
                    error: validation_failed
                    message:
                      name: A certificate with that label already exists. Please choose another label.
                Non-legacy cannot be installed using legacy:
                  value:
                    error: validation_failed
                    message:
                      csr_id: A certificate cannot be installed using a legacy certificate signing request.
                Only installable on production:
                  value:
                    error: validation_failed
                    message:
                      general: Legacy certificates may only be installed on production environments.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to activate SSL certificates on this environment.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: SSL certificates cannot be activated on non-hosted applications.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Incorrect certificate:
                  value:
                    error: forbidden
                    message: This certificate does not belong to the environment, and cannot be set to active.
                Not found or no permission:
                  value:
                    error: forbidden
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Already active:
                  value:
                    error: validation_failed
                    message:
                      general: This certificate is already set as active.
                Legacy certificate:
                  value:
                    error: validation_failed
                    message:
                      general: Legacy certificates cannot be set to active.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Activates an SSL Certificate.
      tags:
      - Environments
      x-cli-name: environments:certificate-activate
  /environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    post:
      description: Deactivates an active SSL certificate.
      operationId: postDeactivateCertificate
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/cb5de18e-5721-4c26-9f67-1a7d806dd09e
                  self:
                    href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/4547/actions/deactivate
                message: Deactivating the certificate.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Legacy certificate:
                  value:
                    error: validation_failed
                    message:
                      general: Legacy certificates cannot be deactivated. In order to deactivate a legacy certificate, the certificate must be removed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to deactivate SSL certificates on this environment.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: SSL certificates cannot be deactivated on non-hosted applications.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Incorrect certificate:
                  value:
                    error: forbidden
                    message: This certificate does not belong to the environment, and cannot be deactivated.
                Not found or no permission:
                  value:
                    error: forbidden
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Already active:
                  value:
                    error: validation_failed
                    message: This certificate is already deactivated.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deactivates an Active SSL Certificate.
      tags:
      - Environments
      x-cli-name: environments:certificate-deactivate
  /environments/{environmentId}/ssl/csrs:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: Returns the certificate signing requests for this environment.
      operationId: getCertificateSigningRequests
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      certificate:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/7
                      self:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/7
                    alternate_names:
                    - site.example.com
                    - other.example.com
                    common_name: www.example.com
                    country: US
                    csr: '-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----'
                    environment:
                      id: 5-a1a10dab-62f4-418c-bc58-ab7742078ba8
                      name: prod
                    flags:
                      legacy: false
                      used: true
                    id: 7
                    locality: Boston
                    organization: Example Inc.
                    organizational_unit: IT
                    private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
                    state: Massachusetts
                  - _links:
                      certificate:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/8
                      self:
                        href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/8
                    alternate_names: []
                    common_name: www.example.com
                    country: US
                    csr: '-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----'
                    environment:
                      id: 5-a1a10dab-62f4-418c-bc58-ab7742078ba8
                      name: prod
                    flags:
                      legacy: true
                      used: false
                    id: 8
                    locality: Boston
                    organization: Example Inc.
                    organizational_unit: IT
                    private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
                    state: Massachusetts
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/ssl
                  self:
                    href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/ssl/csrs
                total: 2
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csrs'
          description: OK
        '404':
          content:
            application/hal+json:
              examples:
                Non-hosted application:
                  value:
                    error: not_found
                    message: Certificate Signing Requests are not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns Certificate Signing Requests.
      tags:
      - Environments
      x-cli-name: environments:csr-list
    post:
      description: Generates a CSR for one or more domains.
      operationId: postCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              alternate_names:
              - www2.example.com
              - www3.example.com
              common_name: www.example.com
              country: CA
              locality: Toronto
              organization: Acquia
              organizational_unit: Networking
              state: Ontario
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-csr'
          application/x-www-form-urlencoded:
            example:
              alternate_names:
              - www2.example.com
              - www3.example.com
              common_name: www.example.com
              country: CA
              locality: Toronto
              organization: Acquia
              organizational_unit: Networking
              state: Ontario
            schema:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-csr'
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/8fdacf25-38e4-4621-b5de-e78638fe2ceb
                  parent:
                    href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl
                  self:
                    href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl/csrs
                message: A CSR is being generated for the selected domain.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to manage SSL certificates on this environment.
                Non-hosted application:
                  value:
                    error: forbidden
                    message: SSL certificates cannot be managed on non-hosted applications.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Incorrect certificate:
                  value:
                    error: forbidden
                    message: This certificate signing request does not belong to the environment, and cannot be used to install a certificate.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                CD environments:
                  value:
                    error: validation_failed
                    message:
                      general: Legacy certificates may not be installed on CD environments.
                Certificate expired:
                  value:
                    error: validation_failed
                    message:
                      certificate: The supplied certificate has expired.
                Certificate unavailable:
                  value:
                    error: validation_failed
                    message:
                      certificate: Certificate CERTIFICATE was issued by UNKNOWN ISSUER for which no certificate is available.
                Duplicate label:
                  value:
                    error: validation_failed
                    message:
                      label: A certificate with that label already exists. Please choose another label.
                Intermediate certificate expired:
                  value:
                    error: validation_failed
                    message:
                      ca_certificates: Intermediate certificate Example Certificate has expired.
                Invalid format:
                  value:
                    error: validation_failed
                    message:
                      certificate: The certificate format is invalid.
                Invalid private key:
                  value:
                    error: validation_failed
                    message:
                      private_key: The supplied private key is invalid.
                Invalid public key:
                  value:
                    error: validation_failed
                    message:
                      certificate: The certificate public key is invalid.
                Legacy CSR:
                  value:
                    error: validation_failed
                    message:
                      csr_id: A certificate cannot be installed using a legacy certificate signing request.
                Legacy certificate:
                  value:
                    error: validation_failed
                    message:
                      general: Legacy certificates may only be installed on production environments.
                Legacy mismatch:
                  value:
                    error: validation_failed
                    message:
                      csr_id: A legacy certificate cannot be installed using a non-legacy certificate signing request.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Conflict
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Generates a Certificate Signing Request (CSR) for One or More Domains.
      tags:
      - Environments
      x-cli-name: environments:csr-create
  /environments/{environmentId}/ssl/csrs/{certificateId}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Deletes the certificate signing request for the certificate specified by id.
      operationId: deleteCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
      responses:
        '202':
          content:
            application/hal+json:
              example:
                _links:
                  notification:
                    href: https://cloud.acquia.com/api/notifications/87c0f979-2f84-4b88-bc5e-8c1670fd2f01
                  parent:
                    href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs
                  self:
                    href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs/7
                message: Deleting the certificate signing request.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Not on Acquia Cloud Free:
                  value:
                    error: validation_failed
                    message:
                      general: This certificate signing request is used for a certificate, and cannot be removed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to delete Certificate Signing Requests on this environment.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Incorrect certificate signing request:
                  value:
                    error: not_found
                    message: This certificate signing request does not belong to the environment, and cannot be removed.
                No environment or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to administer does not exist, or you do not have permission to administer it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Deletes the Certificate Signing Request.
      tags:
      - Environments
      x-cli-name: environments:csr-delete
    get:
      description: Returns details about a specific certificate signing request.
      operationId: getCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  certificate:
                    href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/certificates/7
                  parent:
                    href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs
                  self:
                    href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs/7
                alternate_names:
                - site.example.com
                - other.example.com
                common_name: www.example.com
                country: US
                csr: '-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----'
                environment:
                  id: 5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5
                  name: prod
                flags:
                  legacy: false
                  used: true
                id: 7
                locality: Boston
                organization: Example Inc.
                organizational_unit: IT
                private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----'
                state: Massachusetts
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csr'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                No permission:
                  value:
                    error: forbidden
                    message: You do not have permission to view Certificate Signing Requests on this environment.
                Not on Acquia Cloud Free:
                  value:
                    error: forbidden
                    message: SSL certificates are not available to Acquia Cloud Free subscriptions.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                No CSR or permission:
                  value:
                    error: not_found
                    message: The CSR you are trying to access does not exist, or you do not have permission to access it.
                No environment or permission:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Non-hosted application:
                  value:
                    error: not_found
                    message: Certificate Signing Requests are not available on non-hosted applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      security:
      - Acquia_Cloud_API_Documentation_OAuth2: []
      summary: Acquia Returns the Certificate Signing Request for the Certificate Specified by Id.
      tags:
      - Environments
      x-cli-name: environments:csr-find
  /environments/{environmentId}/variables:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    get:
      description: 'Returns a list of environment variables associated with this environment.


        Filterable fields:

        * `name`


        Sortable fields:

        * `name`

        '
      operationId: getEnvironmentsVariables
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _embedded:
                  items:
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_one
                    name: variable_one
                    value: Sample Value One
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_two
                    name: variable_two
                    value: Sample Value Two
                  - _links:
                      self:
                        href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_three
                    name: variable_three
                    value: Sample Value Three
                _links:
                  filter:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?filter}
                    templated: true
                  limit:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?limit}
                    templated: true
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93
                  self:
                    href: https://cloud.acquia.com/api/environment/24-569086da-2b1f-11e9-b210-d663bd873d93/variables
                  sort:
                    href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?sort}
                    templated: true
                total: 3
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-variables'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view environment variables for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not available for static applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for static applications.
                Not available on Acquia Cloud Site Factory:
                  value:
                    error: not_available
                    message: Environment variables are not available for Acquia Cloud Site Factory applications.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for Service Management-enabled applications.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Returns a List of Environment Variables Associated with This Environment.
      tags:
      - Environments
      x-cli-name: environments:variable-list
    post:
      description: Adds a new environment variable to an environment.
      operationId: postEnvironmentsVariables
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      requestBody:
        content:
          application/hal+json:
            example:
              name: APP_KEY
              value: aaaabbbbccccddddeee
            schema:
              properties:
                name:
                  description: The name of the environment variable to add.
                  maxLength: 255
                  minLength: 1
                  pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$
                  type: string
                value:
                  description: The value of the environment variable to add.
                  maxLength: 255
                  minLength: 0
                  type: string
              type: object
          application/x-www-form-urlencoded:
            example:
              name: APP_KEY
              value: aaaabbbbccccddddeee
            schema:
              properties:
                name:
                  description: The name of the environment variable to add.
                  maxLength: 255
                  minLength: 1
                  pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$
                  type: string
                value:
                  description: The value of the environment variable to add.
                  maxLength: 255
                  minLength: 0
                  type: string
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Variable is being added:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/f3c2bdc1-60c1-48af-8777-996477f901d5
                      parent:
                        href: https://cloud.acquia.com/api/environments/123-c7056b9e-0fb7-44e9-a434-426a404211c1
                      self:
                        href: https://cloud.acquia.com/api/environments/123-c7056b9e-0fb7-44e9-a434-426a404211c1/variables
                    message: The environment variable is being added.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Invalid value:
                  value:
                    error: not_available
                    message:
                      value: 'The environment variable value is invalid: it must be less than 256 characters long.'
                Invalid variable name:
                  value:
                    error: validation_failed
                    message:
                      name: The environment variable name is invalid. It must contain only letters, numbers, and underscores; it cannot start with a number, AH_, or ACQUIA_; and it must be under 256 characters long.
                Variable name already exists:
                  value:
                    error: not_available
                    message:
                      name: The environment already has an environment variable with that name.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to create environment variables for this environment.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for Service Management-enabled applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Not available for static applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for static applications.
                Not available on Acquia Cloud Site Factory:
                  value:
                    error: not_available
                    message: Environment variables are not available for Acquia Cloud Site Factory applications.
                Not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not available:
                  value:
                    error: conflict
                    message: Environment variables are not available for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Adds a New Environment Variable to an Environment.
      tags:
      - Environments
      x-cli-name: environments:variable-create
  /environments/{environmentId}/variables/{environmentVariableName}:
    servers:
    - url: https://cloud.acquia.com/api
      description: Cloud API
    delete:
      description: Removes an environment variable from an environment.
      operationId: deleteEnvironmentsVariable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-variable-name'
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Variable is being removed:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c
                      parent:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/variables
                      self:
                        href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/variables/EXAMPLE_VARIABLE_NAME
                    message: The environment variable is being removed.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Invalid value:
                  value:
                    error: validation_failed
                    message:
                      name: The environment does not have an environment variable with that name.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Environment variable not found:
                  value:
                    error: not_found
                    message: The environment variable you are trying to access does not exist, or you do not have permission to access it.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to remove environment variables for this environment.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for Service Management-enabled applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not available:
                  value:
                    error: conflict
                    message: Environment variables are not available for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Removes an Environment Variable from an Environment.
      tags:
      - Environments
      x-cli-name: environments:variable-delete
    get:
      description: Get an environment variable associated with this environment.
      operationId: getEnvironmentsVariable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-variable-name'
      responses:
        '200':
          content:
            application/hal+json:
              example:
                _links:
                  parent:
                    href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables
                  self:
                    href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables/variable_one
                name: variable_one
                value: Sample Value One
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-variable'
          description: OK
        '403':
          content:
            application/hal+json:
              examples:
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to view environment variables for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
                Environment variable not found:
                  value:
                    error: not_found
                    message: The environment variable you are trying to access does not exist, or you do not have permission to access it.
                Not available on Acquia Cloud Site Factory:
                  value:
                    error: not_available
                    message: Environment variables are not available for Acquia Cloud Site Factory applications.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for Service Management-enabled applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
      summary: Acquia Get an Environment Variable Associated with This Environment.
      tags:
      - Environments
      x-cli-name: environments:variable-find
    put:
      description: Updates an environment variable on an environment.
      operationId: putEnvironmentsVariable
      parameters:
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
      - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-variable-name'
      requestBody:
        content:
          application/hal+json:
            example:
              name: APP_KEY
              value: aaaabbbbccccddddeee
            schema:
              properties:
                name:
                  description: The name of the environment variable to add.
                  maxLength: 255
                  minLength: 1
                  pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$
                  type: string
                value:
                  description: The value of the environment variable to add.
                  maxLength: 255
                  minLength: 0
                  type: string
              required:
              - name
              - value
              type: object
          application/x-www-form-urlencoded:
            example:
              name: APP_KEY
              value: aaaabbbbccccddddeee
            schema:
              properties:
                name:
                  description: The name of the environment variable to add.
                  maxLength: 255
                  minLength: 1
                  pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$
                  type: string
                value:
                  description: The value of the environment variable to add.
                  maxLength: 255
                  minLength: 0
                  type: string
              required:
              - name
              - value
              type: object
        required: true
      responses:
        '202':
          content:
            application/hal+json:
              examples:
                Variable is being updated:
                  value:
                    _links:
                      notification:
                        href: https://cloud.acquia.com/api/notifications/37c8646c-bbe8-423a-970b-cbeb530b981d
                      parent:
                        href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables
                      self:
                        href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables/name
                    message: The environment variable is being updated.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
          description: Accepted
        '400':
          content:
            application/hal+json:
              examples:
                Invalid value:
                  value:
                    error: validation_failed
                    message:
                      value: 'The environment variable value is invalid: it must be less than 5000 characters long.'
                Variable name already exists:
                  value:
                    error: validation_failed
                    message:
                      name: The environment already has an environment variable with that name.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
          description: Bad Request
        '403':
          content:
            application/hal+json:
              examples:
                Environment variable not found:
                  value:
                    error: not_found
                    message: The environment variable you are trying to access does not exist, or you do not have permission to access it.
                Insufficient permissions:
                  value:
                    error: forbidden
                    message: You do not have permission to modify environment variables for this environment.
                Not available on managed applications:
                  value:
                    error: not_available
                    message: Environment variables are not available for Service Management-enabled applications.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Forbidden
        '404':
          content:
            application/hal+json:
              examples:
                Environment not found:
                  value:
                    error: not_found
                    message: The environment you are trying to access does not exist, or you do not have permission to access it.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Not Found
        '409':
          content:
            application/hal+json:
              examples:
                Not available:
                  value:
                    error: conflict
                    message: Environment variables are not available for this environment.
              schema:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
          description: Conflict
      summary: Acquia Updates an Environment Variable on an Environment.
      tags:
      - Environments
      x-cli-name: environments:variable-update
components:
  schemas:
    Acquia_Cloud_API_Documentation_server-configuration:
      description: An array of various configuration settings for the server.
      properties:
        ecu:
          description: The number of EC2 Compute Units (ECU) for this server type.
          nullable: true
          type: integer
        memcache:
          description: Returns the memcache size (in MB) for this server (if it is a memcache server).
          nullable: true
          type: integer
        memory:
          description: Returns the memory size (in GB) for this server type.
          nullable: true
          type: number
      type: object
    Acquia_Cloud_API_Documentation_database-php-config:
      description: Response schema for a database PHP configuration.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        drupal:
          description: The Drupal PHP configuration settings file content.
          type: string
      required:
      - drupal
      - _links
      type: object
    Acquia_Cloud_API_Documentation_available-runtimes:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        runtime:
          description: The runtime.
          enum:
          - php
          - node
          type: string
        versions:
          description: The available versions for this runtime.
          items:
            type: string
          type: array
      required:
      - runtime
      - versions
      - _links
      type: object
    Acquia_Cloud_API_Documentation_cloud-action:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        description:
          description: The description of a Cloud Action.
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-actions-flags'
        id:
          description: The Cloud Action ID.
          format: uuid
          type: string
        label:
          description: The human-readable Cloud Action label.
          type: string
        type:
          description: The type of Cloud Action.
          type: string
      required:
      - id
      - label
      - description
      - type
      - flags
      - _links
      type: object
    Acquia_Cloud_API_Documentation_deploy-code:
      properties:
        cloud-actions:
          description: An optional array of Cloud Actions.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-action-id'
          type: array
        message:
          description: An optional commit message to include when creating a new tag.
          type: string
        source:
          description: The ID of the environment to deploy code from.
          type: string
      required:
      - source
      type: object
    Acquia_Cloud_API_Documentation_stack-metrics-data:
      description: An object containing StackMetrics metrics.
      properties:
        _embedded:
          description: A collection of StackMetrics items matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_stack-metrics-metric'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_csr-flags:
      description: An array of various flags that indicate functionality associated with the CSR.
      properties:
        legacy:
          description: Whether this is a legacy CSR (meant for use with ELB certificates).
          type: boolean
        used:
          description: Whether this CSR has already been used for a certificate.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_environment-options:
      properties:
        _embedded:
          description: An array of environment options.
          properties:
            items:
              items:
                properties:
                  default:
                    description: The default value for a configuration option.
                    nullable: true
                    type: integer
                  maximum:
                    description: The highest value a configuration option can be set.
                    nullable: true
                    type: integer
                  minimum:
                    description: The lowest value a configuration option can be set.
                    nullable: true
                    type: integer
                  name:
                    description: The environment configuration option name.
                    enum:
                    - apcu
                    - interned_strings_buffer
                    - client_max_body_size
                    - max_execution_time
                    - max_input_vars
                    - max_post_size
                    - upload_max_filesize
                    - memory_limit
                    - memcached_limit
                    - opcache
                    - operating_system
                    - version
                    type: string
                  step:
                    description: The step between configuration option values.
                    nullable: true
                    type: integer
                type: object
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_import-site:
      properties:
        name:
          description: The name of the distribution being installed.
          type: string
        url:
          description: The URL of the make file or tarball containing the site to import.
          format: uri
          type: string
      required:
      - url
      type: object
    Acquia_Cloud_API_Documentation_configuration-set:
      description: An Acquia Search configuration set.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        application_uuid:
          description: The UUID for the application the search configuration belongs to.
          type: string
        flags:
          description: The collection of flags for the search configuration set.
          properties:
            custom:
              description: Indicates whether the search configuration set is a custom configuration set.
              type: boolean
          type: object
        health:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
        id:
          description: The search configuration set ID.
          type: string
        label:
          description: The human-readable search configuration set label.
          type: string
        status:
          description: The provisioning status of the search configuration set.
          enum:
          - active
          - pending
          - failed
          - inactive
          type: string
      required:
      - id
      - application_uuid
      - label
      - flags
      - status
      - _links
      type: object
    Acquia_Cloud_API_Documentation_database-stub:
      description: Schema for a stub of information regarding a database.
      properties:
        id:
          description: The ID of the database.
          type: integer
        name:
          description: The database name.
          type: string
      required:
      - id
      - name
      type: object
    Acquia_Cloud_API_Documentation_environment-stub:
      description: Schema for a stub of information regarding an environment.
      properties:
        id:
          description: The ID of the environment. The ID is a compound key consisting of the internal database ID of the environment and the application UUID.
          type: string
        name:
          description: The stage name of the environment.
          type: string
      required:
      - id
      - name
      type: object
    Acquia_Cloud_API_Documentation_cdn:
      description: CDN status information.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        status:
          description: The CDN status.
          enum:
          - active
          - delete-failed
          - deleting
          - disable-failed
          - disabling
          - install-failed
          - installing
          type: string
      required:
      - status
      type: object
    Acquia_Cloud_API_Documentation_put-cloud-actions:
      description: A Cloud Action or a series of Cloud Actions paired with enable or disable boolean value.
      properties:
        cloud-actions:
          additionalProperties:
            description: Whether this Cloud Action is enabled.
            type: boolean
          type: object
      required:
      - cloud-actions
      type: object
    Acquia_Cloud_API_Documentation_certificate-flags:
      description: An array of various flags that indicate functionality associated with the certificate.
      properties:
        active:
          description: Whether this certificate is installed/deployed.
          type: boolean
        csr:
          description: Whether this certificate has an associated CSR.
          type: boolean
        legacy:
          description: Whether this is a legacy certificate (ELB).
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_switch-code:
      properties:
        branch:
          description: The name of the branch or tag to switch to. Tags should be prefixed with "tags/".
          type: string
        cloud-actions:
          description: An optional array of Cloud Actions.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-action-id'
          type: array
      required:
      - branch
      type: object
    Acquia_Cloud_API_Documentation_cloud-action-id:
      description: A Cloud Action ID.
      format: uuid
      type: string
    Acquia_Cloud_API_Documentation_logstream:
      description: Connection details for Logstream backend.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        logstream:
          description: Connection details for Logstream backend.
          properties:
            commands:
              description: Commands for the logstream backend.
              items:
                type: string
              type: array
            params:
              description: Connection details such as a timestamp, hmac, site name and environment.
              type: object
            url:
              description: WebSocket URL.
              format: uri
              type: string
          required:
          - url
          - params
          - commands
          type: object
      required:
      - logstream
      - _links
      type: object
    Acquia_Cloud_API_Documentation_log-forwarding-destination-flags:
      description: Various flags for this log forwarding destination.
      properties:
        certificate_expiring:
          description: Whether the destination certificate is in danger of expiring soon (within 30 days).
          type: boolean
        enabled:
          description: Destination enabled status.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_server:
      description: Server information.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        ami_type:
          description: The Amazon AMI type.
          type: string
        configuration:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server-configuration'
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server-flags'
        hostname:
          description: The hostname for the server.
          type: string
        id:
          description: The ID of the server.
          type: integer
        ip:
          description: The IP address of the server.
          format: ipv4
          type: string
        name:
          description: The machine name of the server.
          type: string
        operating_system:
          description: The operating system running on the server.
          type: string
        region:
          description: The Amazon region the server is in.
          type: string
        roles:
          description: The roles the server has, for its environment.
          items:
            enum:
            - web
            - db
            - bal
            type: string
          type: array
        ssh_user:
          description: The name of the SSH user for this environment.
          type: string
        status:
          description: The status of the server.
          enum:
          - normal
          - stopped
          - launching
          - cancelled
          - unknown
          type: string
      required:
      - id
      - name
      - hostname
      - ssh_user
      - ip
      - status
      - region
      - roles
      - ami_type
      - operating_system
      - configuration
      - flags
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_log:
      description: Details for a log file.
      properties:
        _links:
          description: Links associated with the logfile.
          properties:
            download:
              description: Download data for the logfile.
              properties:
                href:
                  description: The download link for the logfile.
                  format: uri
                  type: string
              type: object
          type: object
        flags:
          description: An array of various flags that indicate functionality associated with the log.
          properties:
            available:
              description: Whether or not this log file is available.
              type: boolean
          type: object
        label:
          description: The human readable label of the logfile.
          type: string
        type:
          description: The machine name for the type of logfile.
          type: string
      required:
      - type
      - label
      - flags
      - _links
      type: object
    Acquia_Cloud_API_Documentation_application-metadata:
      description: Application metadata.
      properties:
        uuids:
          description: Collection of application UUIDs.
          items:
            description: The application UUID.
            format: uuid
            type: string
          type: array
      type: object
    Acquia_Cloud_API_Documentation_server-stub:
      description: Information about the server this cron job is attached to.
      properties:
        id:
          description: The server ID.
          type: string
        name:
          description: The server name.
          type: string
      required:
      - id
      - name
      type: object
    Acquia_Cloud_API_Documentation_cloud-actions-flags:
      description: Various flags for the Cloud Action.
      properties:
        default:
          description: Indicates whether the Cloud Action is a default action.
          type: boolean
        enabled:
          description: Indicates whether the Cloud Action is enabled.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_artifact-stub:
      nullable: true
      properties:
        id:
          description: The artifact identifier.
          format: id
          type: integer
        name:
          description: The name of the artifact.
          type: string
      required:
      - name
      - id
      type: object
    Acquia_Cloud_API_Documentation_database-flags:
      description: Response schema for database flags.
      properties:
        default:
          description: Whether this is the default database.
          type: boolean
        perform_backup:
          description: Whether this database is backed up.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_indexes:
      description: A collection of indexes.
      properties:
        _embedded:
          description: A collection of indexes.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_index'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        pagination:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_pagination'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_search:
      description: A collection of links that provides traversal of search endpoints.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
      required:
      - _links
      type: object
    Acquia_Cloud_API_Documentation_usage:
      description: A collection of traversal links for an entity.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
      required:
      - _links
      type: object
    Acquia_Cloud_API_Documentation_eip:
      properties:
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_eip-flags'
        id:
          description: The Web EIP ID.
          format: uuid
          type: string
        ipv4:
          description: The IPv4 address.
          type: string
        ipv6:
          description: The IPv6 address.
          type: string
        status:
          description: The provisioning status of the Web EIP.
          type: string
      required:
      - id
      - status
      - ipv4
      type: object
    Acquia_Cloud_API_Documentation_message:
      properties:
        message:
          description: A simple message returned from the response.
          type: string
      required:
      - message
      type: object
    Acquia_Cloud_API_Documentation_cdn-information:
      description: Domain-specific CDN information, if CDN is enabled.
      nullable: true
      properties:
        status:
          description: The current provisioning status of CDN for this domain.
          enum:
          - active
          - installing
          - install-failed
          - deleting
          - delete-failed
          - unknown
          type: string
      type: object
    Acquia_Cloud_API_Documentation_environment-variables:
      description: A collection of environment variables.
      properties:
        _embedded:
          description: A collection of variables matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-variable'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_certificates:
      description: A collection of certificates.
      properties:
        _embedded:
          description: A collection of certificates.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificate'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_domains:
      description: A collection of domains.
      properties:
        _embedded:
          description: A collection of domains matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_dns:
      description: Response schema for environment DNS configuration.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        apex_domain:
          deprecated: true
          description: Environment apex domain DNS records.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
          type: array
        global_configuration:
          description: List of global apex and subdomain DNS records.
          properties:
            apex_domain:
              description: Environment global apex domain DNS records.
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
              type: array
            subdomains:
              description: Environment global subdomain DNS records.
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
              type: array
          type: object
        regional_configuration:
          description: List of regional apex and subdomain DNS records.
          properties:
            apex_domain:
              description: Environment regional apex domain DNS records.
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
              type: array
            subdomains:
              description: Environment regional subdomain DNS records.
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
              type: array
          type: object
        subdomains:
          deprecated: true
          description: Environment subdomain DNS records.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
          type: array
      required:
      - apex_domain
      - subdomains
      - regional_configuration
      - global_configuration
      - _links
      type: object
    Acquia_Cloud_API_Documentation_cron-flags:
      description: An array of various flags that indicate functionality associated with cron jobs.
      properties:
        enabled:
          description: Whether this this cron is enabled.
          type: boolean
        on_any_web:
          description: Whether this cron will run on the lowest numbered web.
          type: boolean
        system:
          description: Whether this is a system cron, which cannot be modified.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_environment-flags:
      description: An array of various flags that indicate functionality associated with the environment.
      properties:
        cde:
          description: Determines if the environment is on-demand.
          type: boolean
        cdn:
          description: Determines if the environment has Platform CDN enabled.
          type: boolean
        cloud-actions:
          description: Determines if the environment has Cloud Actions enabled.
          type: boolean
        eips:
          description: Determines if the environment has Web EIPs enabled.
          type: boolean
        email:
          description: Determines if the environment has Platform Email enabled.
          type: boolean
        hsd:
          description: Determines if the environment is under high-site density.
          type: boolean
        livedev:
          description: Determines if the environment has live development enabled.
          type: boolean
        multi_region:
          description: Whether or not the environment is multi-regioned.
          type: boolean
        multicert:
          description: Determines if the environment has multicert enabled.
          type: boolean
        production:
          description: Determines if the environment is production.
          type: boolean
        production_mode:
          description: Determines if the environment has production mode enabled.
          type: boolean
        remote_admin:
          description: Determines if the environment is a remote administration environment.
          type: boolean
        varnish:
          description: Determines if the environment has Varnish.
          type: boolean
        varnish_over_ssl:
          description: Determines if the environment is configured for varnish over SSL.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_crons:
      properties:
        _embedded:
          description: A collection of cron jobs.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cron'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_environment-variable:
      description: An environment variable key and value.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        name:
          description: The name of the variable.
          maxLength: 255
          minLength: 1
          pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$
          type: string
        value:
          description: The value of the variable.
          maxLength: 5000
          minLength: 0
          type: string
      required:
      - name
      - value
      - _links
      type: object
    Acquia_Cloud_API_Documentation_domain-flags:
      description: An array of flags representing features of the domain.
      properties:
        active:
          description: If the domain is considered to be the main or active domain in this environment.
          type: boolean
        default:
          description: If the domain is the default domain of the environment.
          type: boolean
        wildcard:
          description: If this is a wildcard domain.
          type: boolean
      required:
      - default
      - active
      - wildcard
      type: object
    Acquia_Cloud_API_Documentation_csr:
      description: A certificate signing request.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        alternate_names:
          description: The subject alternate names (sni only).
          items:
            format: hostname
            type: string
          type: array
        common_name:
          description: The common name (host and domain name).
          type: string
        country:
          description: The ISO-3166 country code.
          type: string
        csr:
          description: The PEM encoded string containing the entire CSR.
          type: string
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csr-flags'
        id:
          description: The hosting ID of the CSR/SSL Certificate (0 for 'elb' type).
          type: integer
        locality:
          description: The locality (city/town/township).
          type: string
        organization:
          description: The organization name.
          type: string
        organizational_unit:
          description: The organizational unit (department).
          type: string
        private_key:
          description: The PEM encoded private key.
          type: string
        state:
          description: The state/province.
          type: string
      required:
      - id
      - csr
      - private_key
      - country
      - state
      - locality
      - organization
      - organizational_unit
      - common_name
      - alternate_names
      - flags
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_certificate:
      description: An SSL certificate.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        ca:
          description: The CA intermediary chain.
          type: string
        certificate:
          description: Returns the PEM encoded certificate.
          type: string
        domains:
          description: The domain names that this certificate is covering.
          items:
            type: string
          type: array
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        expires_at:
          description: The ISO-8601 formatted date/time of the certificates expiration date.
          format: date-time
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificate-flags'
        id:
          description: The ID of the certificate.
          type: integer
        label:
          description: The certificate label (SNI only).
          nullable: true
          type: string
        private_key:
          description: The PEM encoded private key.
          type: string
      required:
      - id
      - certificate
      - private_key
      - ca
      - flags
      - expires_at
      - domains
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_databases:
      description: A collection of databases.
      properties:
        _embedded:
          description: A collection of databases matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_log-forwarding-destinations:
      description: A collection of Log Forwarding destinations.
      properties:
        _embedded:
          description: A collection of log forwarding destinations matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_backup-flags:
      description: Response schema for database backup flags.
      properties:
        deleted:
          description: Whether this database is deleted.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_put-cron:
      properties:
        command:
          description: The command to run.
          type: string
        frequency:
          description: The cron string that describes the frequency the cron will be run at.
          type: string
        label:
          description: The label for this cron.
          type: string
      type: object
    Acquia_Cloud_API_Documentation_environment-usage-metric:
      description: Provides details about views and visits for an environment.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        datapoints:
          description: The data points for the pricing metrics request.
          items:
            description: Each element includes the value for the requested metric and the sampling time.
            items:
              description: The first element is the metric value and the second is the sampling time.
              type: string
            type: array
          type: array
        last_data_at:
          description: The last time data was polled for the requested metric.
          format: date-time
          type: string
        metadata:
          description: The metadata for the data points being returned.
          properties:
            application:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-metadata'
            environment:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-metadata'
            subscription:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-metadata'
          type: object
        metric:
          description: The type of metric requested.
          enum:
          - views
          - visits
          type: string
      required:
      - metric
      - datapoints
      - metadata
      - last_data_at
      type: object
    Acquia_Cloud_API_Documentation_cron:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        command:
          description: The cron command.
          type: string
        day_month:
          description: The cron expression day of the month.
          type: string
        day_week:
          description: The cron expression day of the week.
          type: string
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cron-flags'
        hour:
          description: The cron expression hour.
          type: string
        id:
          description: The ID of the cron job.
          format: uuid
          type: string
        label:
          description: The label for the cron.
          type: string
        minute:
          description: The cron expression minute.
          type: string
        month:
          description: The cron expression month.
          type: string
        server:
          oneOf:
          - items: {}
            type: array
          - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server-stub'
      required:
      - id
      - server
      - command
      - minute
      - hour
      - day_month
      - month
      - day_week
      - label
      - flags
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_servers:
      description: A collection of servers.
      properties:
        _embedded:
          description: A collection of servers matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_mod-proxy:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        status:
          description: The enablement state of Mod Proxy.
          enum:
          - active
          - inactive
          type: string
      required:
      - status
      type: object
    Acquia_Cloud_API_Documentation_vcs:
      properties:
        path:
          description: The path or branch name.
          nullable: true
          type: string
        type:
          description: The type of VCS.
          enum:
          - git
          - svn
          type: string
        url:
          description: The VCS url.
          type: string
      required:
      - type
      - path
      - url
      type: object
    Acquia_Cloud_API_Documentation_eips:
      properties:
        _embedded:
          description: A collection of Web EIPs.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_eip'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_log-forwarding-destination-credentials:
      description: The Log Forwarding destination credentials.
      properties:
        certificate:
          description: A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly.
          properties:
            certificate:
              description: A public X.509 certificate in PEM format.
              type: string
            expires_at:
              description: The ISO-8601 date the certificate will expire at. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk.
              format: date-time
              type: string
          type: object
        key:
          description: The certificate private key, in PEM format, used to encrypt the log traffic. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly.
          nullable: true
          type: string
        token:
          description: An API token associated with the consumer. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk.
          nullable: true
          type: string
      required:
      - certificate
      type: object
    Acquia_Cloud_API_Documentation_domain-status:
      description: Domain status information.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        cnames:
          description: An array of this domain's cnames.
          items:
            type: string
          type: array
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-status-flags'
        hostname:
          description: The domain hostname.
          type: string
        ip_addresses:
          description: An array of this domain's IP addresses.
          items:
            format: ipv4
            type: string
          type: array
      required:
      - hostname
      - flags
      - ip_addresses
      - cnames
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_csrs:
      description: A collection of csrs.
      properties:
        _embedded:
          description: A collection of CSRs.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csr'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_environment-metadata:
      description: Environment metadata.
      properties:
        ids:
          description: An array of environment identifiers.
          items:
            type: string
          type: array
      type: object
    Acquia_Cloud_API_Documentation_domain:
      description: Response schema for a domain.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        cdn:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cdn-information'
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-flags'
        hostname:
          description: The domain's hostname.
          type: string
      required:
      - hostname
      - cdn
      - flags
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_environment-settings:
      description: A collection of links to environment settings.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
      required:
      - _links
      type: object
    Acquia_Cloud_API_Documentation_message-with-links:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        message:
          description: The human-friendly confirmation of the creation of the resource.
          type: string
      required:
      - message
      - _links
      type: object
    Acquia_Cloud_API_Documentation_dns-record:
      description: A DNS record.
      properties:
        type:
          description: The type of DNS record.
          enum:
          - A
          - AAAA
          - CNAME
          type: string
        value:
          description: The DNS record value.
          type: string
      required:
      - type
      - value
      type: object
    Acquia_Cloud_API_Documentation_stack-metrics-metric:
      description: An object containing StackMetrics datapoints.
      properties:
        datapoints:
          description: The data points for the StackMetrics request.
          items:
            description: Each element includes the value and the sampling time for the requested metric.
            items:
              description: Each datapoint is a tuple consisting of two elements - a value and a Unix timestamp.
              type: string
            type: array
          type: array
        last_data_at:
          description: The ISO-8601 date time when the last datapoint was sampled.
          format: date-time
          type: string
        metadata:
          description: The metadata describing the context for the metric.
          properties:
            host:
              description: The corresponding hostname for the StackMetrics datapoints.
              type: string
          type: object
        metric:
          description: The name of the type of StackMetrics metric.
          enum:
          - apache-requests
          - bal-cpu
          - bal-memory
          - cron-memory
          - db-cpu
          - db-disk-size
          - db-disk-usage
          - db-memory
          - file-disk-size
          - file-cpu
          - file-disk-usage
          - file-memory
          - http-2xx
          - http-3xx
          - http-4xx
          - http-5xx
          - mysql-slow-query-count
          - nginx-requests
          - out-of-memory
          - php-proc-max-reached-site
          - php-proc-max-reached-total
          - php-proc-site
          - php-proc-total
          - varnish-cache-hit-rate
          - varnish-requests
          - web-cpu
          - web-memory
          type: string
      required:
      - metric
      - datapoints
      - last_data_at
      - metadata
      type: object
    Acquia_Cloud_API_Documentation_backups:
      description: A collection of database backups.
      properties:
        _embedded:
          description: A collection of database backups matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup-no-embedded'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_ssl:
      description: The SSL settings for an environment.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        balancer:
          description: SSL configuration for the load balancer associated with this environment.
          properties:
            hostname:
              description: The balancer CNAME.
              format: hostname
              type: string
          type: object
        ips:
          description: The IP addresses for the environment.
          items:
            format: ipv4
            type: string
          type: array
      required:
      - balancer
      - ips
      - _links
      type: object
    Acquia_Cloud_API_Documentation_environment-usage-metrics:
      description: A collection of usage metrics for an environment.
      properties:
        _embedded:
          description: A collection of environment metric items matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-usage-metric'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_eip-flags:
      description: Various flags for the Web EIP.
      properties:
        active:
          description: A flag indicating whether the Web EIP is configured to actively receive traffic.
          type: boolean
        deprecated:
          description: A flag indicating whether the Web EIP is flagged for deprecation.
          type: boolean
        legacy:
          description: A flag indicating whether the Web EIP is associated with ACC infrastructure.
          type: boolean
      required:
      - active
      type: object
    Acquia_Cloud_API_Documentation_log-forwarding-destination:
      description: The Log Forwarding destination.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        address:
          description: The URL or host name and port of the destination.
          type: string
        consumer:
          description: The application or provider consuming the logs.
          enum:
          - loggly
          - splunk
          - sumologic
          - syslog
          type: string
        credentials:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination-credentials'
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination-flags'
        health:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
        label:
          description: The human-friendly identifier of the destination.
          type: string
        sources:
          description: The list of log sources to forward.
          items:
            description: A log source.
            enum:
            - apache-access
            - apache-error
            - varnish-access
            - drupal-request
            - drupal-watchdog
            - php-error
            - stdout
            - stderr
            type: string
          type: array
        status:
          description: The current status of the destination.
          enum:
          - active
          - pending
          - installing
          - install-failed
          - deleting
          - delete-failed
          - disabling
          - disable-failed
          - inactive
          - failing
          type: string
        uuid:
          description: The string representation of the unique identifier of the destination.
          format: uuid
          type: string
      required:
      - uuid
      - label
      - sources
      - consumer
      - credentials
      - address
      - status
      - flags
      - health
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_domain-status-flags:
      description: An array of hosting flags for the domain.
      properties:
        acquia_hosted:
          description: Whether or not this domain is Acquia-hosted.
          type: boolean
        active:
          description: Whether or not this domain is active.
          type: boolean
        default:
          description: Whether or not this is the default domain.
          type: boolean
        dns_resolves:
          description: Whether or not this domain resolves in DNS.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_subscription-metadata:
      description: Subscription metadata.
      properties:
        uuids:
          description: An array of subscription unique identifiers.
          items:
            format: uuid
            type: string
          type: array
      type: object
    Acquia_Cloud_API_Documentation_server-flags:
      description: An array of various flags that indicate functionality for the server.
      properties:
        active_bal:
          description: Determines if the server is an active web server or not.
          type: boolean
        active_web:
          description: Determines if the server is an active balancer or not.
          type: boolean
        balancer:
          description: Determines if the server is a balancer.
          type: boolean
        database:
          description: Determines if the server is a database server.
          type: boolean
        dedicated:
          description: Determines if the server is dedicated or shared.
          type: boolean
        elastic_ip:
          description: Determines if the server has an elastic (static) IP or not.
          type: boolean
        fs:
          description: Determines if the server is a file server.
          type: boolean
        memcache:
          description: Determines if the server is a memcache server.
          type: boolean
        primary_db:
          description: 'Determines if the server is the primary database.


            Note that "false" does not imply that this is the secondary database. The server must be a database, and not primary in order to be the secondary database.

            '
          type: boolean
        self_service:
          description: Determines if the server is self-service.
          type: boolean
        web:
          description: Determines if the server is a web server.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_post-csr:
      description: Certificate signing request POST schema.
      properties:
        alternate_names:
          description: The Subject Alternate Names (SNI only) for CSR generation.
          items:
            format: hostname
            type: string
          type: array
        common_name:
          description: The common name (domain) for CSR generation.
          type: string
        country:
          description: The ISO-3166 country code for CSR generation.
          type: string
        locality:
          description: The locality (city/town/township) for CSR generation.
          type: string
        organization:
          description: The organization name for CSR generation.
          type: string
        organizational_unit:
          description: The organizational unit (department) for CSR generation.
          type: string
        state:
          description: The state/province for CSR generation.
          type: string
      required:
      - country
      - state
      - locality
      - organization
      - organizational_unit
      - common_name
      type: object
    Acquia_Cloud_API_Documentation_application-stub:
      properties:
        name:
          description: The name of the application.
          type: string
        uuid:
          description: The application UUID.
          format: uuid
          type: string
      required:
      - name
      - uuid
      type: object
    Acquia_Cloud_API_Documentation_backup-no-embedded:
      description: Response schema for a database backup.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        completed_at:
          description: The ISO-8601 formatted date/time of when the backup process was completed.
          format: date-time
          type: string
        database:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-stub'
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup-flags'
        id:
          description: The ID of the database backup.
          type: integer
        started_at:
          description: The ISO-8601 formatted date/time of when the backup process was started.
          format: date-time
          type: string
        type:
          description: The type of backup this is.
          type: string
      required:
      - id
      - database
      - type
      - started_at
      - completed_at
      - flags
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_post-cron:
      properties:
        command:
          description: The command to run.
          type: string
        frequency:
          description: The cron string that describes the frequency the cron will be run at.
          type: string
        label:
          description: The label for this cron.
          type: string
      required:
      - command
      - frequency
      - label
      type: object
    Acquia_Cloud_API_Documentation_pagination:
      description: A collection of pagination properties.
      properties:
        limit:
          description: The limit on the number of objects in the collection.
          type: integer
        offset:
          description: The offset on the retrieved objects in the collection.
          type: integer
        total:
          description: The total number of objects in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_environment-configuration:
      description: An array of configuration details for the environment.
      properties:
        apcu:
          default: 32
          description: APCu shared memory size per web server.
          maximum: 512
          minimum: 32
          nullable: true
          type: integer
        client_max_body_size:
          default: 256
          description: Sets the maximum size of the client request body.
          maximum: 1024
          minimum: 0
          nullable: true
          type: integer
        interned_strings_buffer:
          default: 8
          description: Sets PHP Opcache key count per server.
          maximum: 32
          minimum: 8
          nullable: true
          type: integer
        max_execution_time:
          default: 300
          description: Limits PHP request time in seconds.
          maximum: 300
          minimum: 1
          nullable: true
          type: integer
        max_input_vars:
          default: 1000
          description: Limits the number of various request items in PHP.
          maximum: 20000
          minimum: 500
          nullable: true
          type: integer
        max_post_size:
          default: 256
          description: Sets the PHP limit on POST body size.
          maximum: 1024
          minimum: 64
          nullable: true
          type: integer
        memcached_limit:
          default: 64
          description: Sets the maximum amount of memory in MB that can be allocated to memcached. Only available on Acquia Cloud Next.
          maximum: 12288
          minimum: 0
          nullable: true
          type: integer
        memory_limit:
          default: 128
          description: Limits PHP request memory usage in megabytes.
          maximum: 1024
          minimum: 128
          nullable: true
          type: integer
        opcache:
          default: 96
          description: This is the total amount of memory available for caching precompiled script bytecode per PHP/FPM process.
          maximum: 512
          minimum: 96
          nullable: true
          type: integer
        operating_system:
          description: The operating system version.
          type: string
        upload_max_filesize:
          default: 256
          description: Sets the maximum size of an uploaded file.
          maximum: 1024
          minimum: 0
          nullable: true
          type: integer
        version:
          description: The PHP or Node version.
          type: string
      type: object
    Acquia_Cloud_API_Documentation_metrics:
      description: A collection of links that provides traversal of metrics endpoints.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
      required:
      - _links
      type: object
    Acquia_Cloud_API_Documentation_validation-error:
      description: A validation error.
      properties:
        error:
          description: The error summary.
          type: string
        message:
          additionalProperties:
            type: string
          description: The validation error message keyed by its field or group name.
          type: object
      required:
      - error
      - message
      type: object
    Acquia_Cloud_API_Documentation_file-download:
      description: A JSON response containing the url and url expiration.
      properties:
        expires_at:
          description: The expiration for the url.
          type: string
        url:
          description: The url for the download.
          type: string
      required:
      - url
      - expires_at
      type: object
    Acquia_Cloud_API_Documentation_logs:
      description: A collection of logs.
      properties:
        _embedded:
          description: A collection of logs matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_post-certificate:
      description: Certificate POST schema.
      properties:
        ca_certificates:
          description: The CA intermediary certificates.
          type: string
        certificate:
          description: The SSL certificate being installed.
          type: string
        csr_id:
          description: The CSR (certificate signing request) to associate with this certificate. Optional.
          type: integer
        label:
          description: The label for this certificate. Required for standard certificates. Optional for legacy certificates.
          type: string
        legacy:
          description: Must be set to true for legacy certificates.
          type: boolean
        private_key:
          description: The SSL private key.
          type: string
      required:
      - certificate
      - private_key
      type: object
    Acquia_Cloud_API_Documentation_health:
      description: The current health for this resource.
      properties:
        code:
          description: The status code for the current health.
          type: string
        details:
          description: Full details about the current health code.
          type: string
        summary:
          description: A brief summary that explains why the health code is present.
          type: string
      type: object
    Acquia_Cloud_API_Documentation_cloud-actions:
      properties:
        _embedded:
          description: A collection of Cloud Actions.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-action'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        total:
          description: The number of items returned in the collection.
          type: integer
      type: object
    Acquia_Cloud_API_Documentation_file:
      description: A binary file response.
      format: binary
      type: string
    Acquia_Cloud_API_Documentation_backup:
      description: Response schema for a database backup.
      properties:
        _embedded:
          description: Related entities.
          properties:
            database:
              description: The related database.
              properties:
                _links:
                  $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
                id:
                  description: The database ID.
                  type: integer
                name:
                  description: The database name.
                  type: string
              type: object
            environment:
              description: The related environment.
              properties:
                _links:
                  $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
                id:
                  description: The environment ID.
                  type: string
                name:
                  description: The environment name.
                  type: string
              type: object
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        completed_at:
          description: The ISO-8601 formatted date/time of when the backup process was completed.
          format: date-time
          type: string
        database:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-stub'
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup-flags'
        id:
          description: The ID of the database backup.
          type: integer
        started_at:
          description: The ISO-8601 formatted date/time of when the backup process was started.
          format: date-time
          type: string
        type:
          description: The type of backup this is.
          type: string
      required:
      - id
      - database
      - type
      - started_at
      - completed_at
      - flags
      - environment
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_database:
      description: Response schema for a database.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        db_host:
          description: The server the database lives on, relative to the SSH host.
          format: hostname
          type: string
        environment:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-flags'
        id:
          description: The ID of the database.
          type: integer
        name:
          description: The database name.
          type: string
        password:
          description: The password for the database user.
          type: string
        ssh_host:
          description: The server to SSH to, in order to access the database on the CLI.
          format: hostname
          type: string
        url:
          description: The connection URL.
          format: uri
          type: string
        user_name:
          description: The database user name.
          type: string
      required:
      - id
      - name
      - user_name
      - password
      - url
      - db_host
      - ssh_host
      - flags
      - environment
      - _links
      type: object
    Acquia_Cloud_API_Documentation_environment:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        active_domain:
          description: The active domain name for this environment.
          format: hostname
          type: string
        application:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
        artifact:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact-stub'
        balancer:
          description: 'The balancer type.

            - balancers: The environment is behind a Legacy balancer.

            - elb: The environment is behind an ELB balancer.

            - cluster: The environment is behind an Edge Cluster balancer.

            '
          enum:
          - balancers
          - elb
          - cluster
          type: string
        configuration:
          description: A collection of environment configuration information.
          nullable: true
          properties:
            operating_system:
              description: The environment operation system.
              type: string
            php:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
          type: object
        default_domain:
          description: The default domain name for this environment.
          format: hostname
          type: string
        domains:
          description: An array of domain names attached to this environment.
          items:
            format: hostname
            type: string
          type: array
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-flags'
        id:
          description: The ID of the environment. The ID is a compound key consisting of the internal database ID of the environment and the application UUID.
          type: string
        image_url:
          description: The URL to the image for this environment.
          format: uri
          nullable: true
          type: string
        ips:
          deprecated: true
          description: An array of IP addresses attached to this environment.
          items:
            format: ipv4
            type: string
          type: array
        label:
          description: The human-readable name of the environment.
          type: string
        name:
          description: The stage name of the environment.
          type: string
        platform:
          description: 'The platform type.

            - cloud: The environment is hosted on a Cloud Classic Platform.

            - cloud-next: The environment is hosted on a Cloud Next Platform.

            - unknown:  The host information is not available for the environment.

            '
          enum:
          - cloud
          - cloud-next
          - unknown
          type: string
        region:
          description: The region the environment resides in.
          type: string
        size:
          description: The size of the environment. Will be null if the environment type does not support sizes.
          enum:
          - small
          - medium
          - large
          - unknown
          nullable: true
          type: string
        ssh_url:
          description: The URL used to SSH into the environment.
          type: string
        status:
          description: The status of this environment.
          type: string
        type:
          description: 'The type of environment.

            - node: A NodeJS environment.

            - drupal: A Drupal environment.

            - ssg: A Static Site Generator environment.

            - unknown: We were unable to determine the environment type.

            '
          enum:
          - node
          - drupal
          - ssg
          - unknown
          type: string
        vcs:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_vcs'
        weight:
          description: The environment weight for display purposes.
          nullable: true
          type: integer
      required:
      - id
      - label
      - name
      - application
      - domains
      - active_domain
      - default_domain
      - image_url
      - ssh_url
      - ips
      - region
      - balancer
      - platform
      - status
      - type
      - size
      - weight
      - vcs
      - flags
      - configuration
      - artifact
      - _links
      type: object
    Acquia_Cloud_API_Documentation_operating-systems:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        versions:
          description: The operating systems.
          items:
            properties:
              available:
                description: Flag to show if the version is available for which to switch.
                type: boolean
              label:
                description: The label of the version.
                type: string
              name:
                description: The codename associated with the version.
                type: string
              version:
                description: The numerical representation of the version.
                type: string
            type: object
          type: array
      required:
      - versions
      - _links
      type: object
    Acquia_Cloud_API_Documentation_error:
      properties:
        error:
          description: The error summary.
          type: string
        message:
          description: The long description for the returned error.
          type: string
      required:
      - error
      - message
      type: object
    Acquia_Cloud_API_Documentation_index:
      description: An Acquia Search index.
      properties:
        _embedded:
          description: The configuration set associated with the index.
          properties:
            configuration_set:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-set'
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        config_set_id:
          description: The search configuration set ID.
          type: string
        database_role:
          description: The database role.
          type: string
        environment_id:
          description: The ID for the environment the search index belongs to.
          type: string
        health:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
        id:
          description: The index ID.
          type: string
        solr_version:
          description: The Solr version the index is currently running on.
          type: string
        status:
          description: The state for the index.
          enum:
          - active
          - pending
          - failed
          - inactive
          type: string
        url:
          description: The index URL.
          type: string
      required:
      - id
      - environment_id
      - config_set_id
      - database_role
      - status
      - solr_version
      - url
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_links:
      description: HAL links about the current resource.
      properties:
        self:
          description: A link to this page.
          properties:
            href:
              description: The URI for this page.
              format: uri
              type: string
          required:
          - href
          type: object
      required:
      - self
      type: object
  parameters:
    Acquia_Cloud_API_Documentation_filter:
      description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.


        There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:


        * Equals: `= (%3D)`

        * Does not equal: `!= (!%3D)`

        * Greater than: `> (%3E)`

        * Less than: `< (%3C)`

        * Greater than or equal to: `>= (%3E%3D)`

        * Less than or equal to: `<= (%3C%3D)`

        * Contains substring: `=@ (%3D@)`

        * Does not contain substring: `!@ (!@)`


        Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).


        Some examples:

        * `filter=field%3Dvalue` (`field` equals `''value''`)

        * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)

        * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)

        * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals `''value''` AND `field2` > `5`)

        '
      in: query
      name: filter
      required: false
      schema:
        minimum: 1
        type: string
    Acquia_Cloud_API_Documentation_filter-stack-metrics:
      description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.


        There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:


        * Equals: `= (%3D)`

        * Does not equal: `!= (!%3D)`

        * Greater than: `> (%3E)`

        * Less than: `< (%3C)`

        * Greater than or equal to: `>= (%3E%3D)`

        * Less than or equal to: `<= (%3C%3D)`

        * Contains substring: `=@ (%3D@)`

        * Does not contain substring: `!@ (!@)`


        Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).


        Some examples:

        * `filter=field%3Dvalue` (`field` equals `''value''`)

        * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)

        * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)

        * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals `''value''` AND `field2` > `5`)


        **For this endpoint, the "metric" filter is required. Multiple metrics can be returned in one request. The following metrics are available:**


        * apache-requests, bal-cpu, bal-memory, cron-memory, db-cpu, db-disk-size, db-disk-usage, db-memory, file-disk-size, file-cpu, file-disk-usage, file-memory, http-2xx, http-3xx, http-4xx, http-5xx, mysql-slow-query-count, nginx-requests, out-of-memory, php-proc-max-reached-site, php-proc-max-reached-total, php-proc-site, php-proc-total, varnish-cache-hit-rate, varnish-requests, web-cpu, web-memory

        '
      in: query
      name: filter
      required: true
      schema:
        minimum: 1
        type: string
    Acquia_Cloud_API_Documentation_server-id:
      description: The internal database identifier of the server.
      example: '42'
      in: path
      name: serverId
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_deprecated-to:
      deprecated: true
      description: (Use filter `to` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `from` query.
      example: '2020-01-01'
      in: query
      name: to
      required: false
      schema:
        type: string
    Acquia_Cloud_API_Documentation_environment-id:
      description: The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID.
      example: 12-d314739e-296f-11e9-b210-d663bd873d93
      in: path
      name: environmentId
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_index-id:
      description: An ID that uniquely identifies an index.
      example: ABCDE-1234.test.example
      in: path
      name: indexId
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_environment-variable-name:
      description: The environment variable name.
      example: EXAMPLE_VARIABLE_NAME
      in: path
      name: environmentVariableName
      required: true
      schema:
        maxLength: 255
        minLength: 1
        pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$
        type: string
    Acquia_Cloud_API_Documentation_certificate-id:
      description: An ID that uniquely identifies a certificate.
      example: 7
      in: path
      name: certificateId
      required: true
      schema:
        type: integer
    Acquia_Cloud_API_Documentation_from-stack-metrics:
      description: An ISO-8601 formatted date retrieve metrics from.
      example: '2021-01-29T22:45:21+00:00'
      in: query
      name: from
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_filter-usage-metrics:
      description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.


        Filter parameters include:

        * `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.

        * `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.


        Formatting examples:

        * `2023-09-01`

        * `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)


        Usage examples:

        * `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)

        * `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)

        '
      in: query
      name: filter
      required: false
      schema:
        minimum: 1
        type: string
    Acquia_Cloud_API_Documentation_log-type:
      description: An ID that uniquely identifies a log type.
      example: php-error
      in: path
      name: logType
      required: true
      schema:
        enum:
        - apache-access
        - apache-error
        - drupal-request
        - drupal-watchdog
        - fpm-access
        - fpm-error
        - php-error
        - cloud-hook
        - cronjob
        - mysql-slow-query
        type: string
    Acquia_Cloud_API_Documentation_deprecated-from:
      deprecated: true
      description: (Use filter `from` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `to` query.
      example: '2019-10-01'
      in: query
      name: from
      required: false
      schema:
        type: string
    Acquia_Cloud_API_Documentation_offset:
      description: An integer to signify the offset to paginate from.
      example: 10
      in: query
      name: offset
      required: false
      schema:
        type: integer
    Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid:
      description: The entity's universally unique identifier.
      example: dbd8a966-2b25-11e9-b210-d663bd873d93
      in: path
      name: logForwardingDestinationUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_sort:
      description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

        '
      example: field1,-field2
      in: query
      name: sort
      required: false
      schema:
        minimum: 1
        type: string
    Acquia_Cloud_API_Documentation_limit:
      description: The maximum number of items to return.
      example: 10
      in: query
      name: limit
      required: false
      schema:
        type: integer
    Acquia_Cloud_API_Documentation_to-no-default:
      description: An ISO-8601 formatted date retrieve results to.
      example: '2021-01-29T23:55:21+00:00'
      in: query
      name: to
      required: false
      schema:
        type: string
    Acquia_Cloud_API_Documentation_domain:
      description: A domain name.
      example: example.com
      in: path
      name: domain
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_usage-metric:
      description: A usage data metric type.
      example: views
      in: path
      name: usageMetric
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_backup-id:
      description: The database backup identifier.
      example: 1
      in: path
      name: backupId
      required: true
      schema:
        type: integer
    Acquia_Cloud_API_Documentation_resolution:
      description: 'Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.


        Limits:

        - 3 hour limit for “minute” resolution

        - 1 week limit for “hour” resolution

        - 6 month limit for “day” resolution

        - 1 year limit for "week" resolution

        - 3 year limit for “month” resolution

        '
      in: query
      name: resolution
      required: false
      schema:
        enum:
        - minute
        - hour
        - day
        - week
        - month
        type: string
    Acquia_Cloud_API_Documentation_cron-id:
      description: An ID that uniquely identifies a cron job.
      example: e10a665c-c9ec-4422-a82b-b32c82329f9d
      in: path
      name: cronId
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_database-name:
      description: The database name, typically lower snake case.
      example: my_db
      in: path
      name: databaseName
      required: true
      schema:
        type: string
  securitySchemes:
    Acquia_Cloud_API_Documentation_OAuth2:
      description: '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 token:


        1. Sign in to the [Acquia Cloud](https://cloud.acquia.com/) interface using your email address and Acquia password.

        2. Click your user avatar in the upper right corner, and then click **Account Settings**.

        3. On the Profile page, click **API Tokens**.

        4. Click **Create Token**.

        5. In the pop-up that appears, give your token a label so that you can easily find it later. Then click **Create Token**.

        6. Copy your API key and API secret. Click **OK**.

        '
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://accounts.acquia.com/api/token
      type: oauth2
    Codebase_Service_JWT:
      description: Value for the Authorization header parameter.
      in: header
      name: Authorization
      type: apiKey
    MEO_Environment_Service_JWT:
      description: Value for the Authorization header parameter.
      in: header
      name: Authorization
      type: apiKey
    Site_Service_JWT:
      description: Value for the Authorization header parameter.
      in: header
      name: Authorization
      type: apiKey