components:
  examples: {}
  headers: {}
  parameters:
    Acquia_Cloud_API_Documentation_AgreementUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_agreement-uuid'
    Acquia_Cloud_API_Documentation_AlertUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_alert-uuid'
    Acquia_Cloud_API_Documentation_ApmType:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_apm-type'
    Acquia_Cloud_API_Documentation_ApplicationUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
    Acquia_Cloud_API_Documentation_ArtifactId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_artifact-id'
    Acquia_Cloud_API_Documentation_BackupId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_backup-id'
    Acquia_Cloud_API_Documentation_CertificateId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id'
    Acquia_Cloud_API_Documentation_ConfigurationSetId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_configuration-set-id'
    Acquia_Cloud_API_Documentation_CronId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id'
    Acquia_Cloud_API_Documentation_DatabaseName:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name'
    Acquia_Cloud_API_Documentation_DeprecatedFrom:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_deprecated-from'
    Acquia_Cloud_API_Documentation_DeprecatedTo:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_deprecated-to'
    Acquia_Cloud_API_Documentation_Domain:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain'
    Acquia_Cloud_API_Documentation_DomainRegistrationUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
    Acquia_Cloud_API_Documentation_DrushVersion:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_drush-version'
    Acquia_Cloud_API_Documentation_EnvironmentId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id'
    Acquia_Cloud_API_Documentation_EnvironmentVariableName:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-variable-name'
    Acquia_Cloud_API_Documentation_Filter:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
    Acquia_Cloud_API_Documentation_FilterStackMetrics:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-stack-metrics'
    Acquia_Cloud_API_Documentation_FilterUsageMetrics:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
    Acquia_Cloud_API_Documentation_From:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
    Acquia_Cloud_API_Documentation_FromNoDefault:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from-no-default'
    Acquia_Cloud_API_Documentation_FromStackMetrics:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from-stack-metrics'
    Acquia_Cloud_API_Documentation_IdeUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_ide-uuid'
    Acquia_Cloud_API_Documentation_IdentityProviderUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid'
    Acquia_Cloud_API_Documentation_IndexId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_index-id'
    Acquia_Cloud_API_Documentation_Limit:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
    Acquia_Cloud_API_Documentation_LogForwardingDestinationUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid'
    Acquia_Cloud_API_Documentation_LogType:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-type'
    Acquia_Cloud_API_Documentation_MessageUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_message-uuid'
    Acquia_Cloud_API_Documentation_Name:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_name'
    Acquia_Cloud_API_Documentation_NotificationUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_notification-uuid'
    Acquia_Cloud_API_Documentation_Offset:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
    Acquia_Cloud_API_Documentation_OrganizationUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
    Acquia_Cloud_API_Documentation_Permission:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_permission'
    Acquia_Cloud_API_Documentation_Range:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_range'
    Acquia_Cloud_API_Documentation_Resolution:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
    Acquia_Cloud_API_Documentation_RoleUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid'
    Acquia_Cloud_API_Documentation_ServerId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id'
    Acquia_Cloud_API_Documentation_ServerType:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-type'
    Acquia_Cloud_API_Documentation_ShieldAclUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_shield-acl-uuid'
    Acquia_Cloud_API_Documentation_SiteId:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_site-id'
    Acquia_Cloud_API_Documentation_Sort:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
    Acquia_Cloud_API_Documentation_SshKeyUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_ssh-key-uuid'
    Acquia_Cloud_API_Documentation_StackMetricsMetricType:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_stack-metrics-metric-type'
    Acquia_Cloud_API_Documentation_SubscriptionUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
    Acquia_Cloud_API_Documentation_TagName:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_tag-name'
    Acquia_Cloud_API_Documentation_TeamUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid'
    Acquia_Cloud_API_Documentation_To:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to'
    Acquia_Cloud_API_Documentation_ToNoDefault:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to-no-default'
    Acquia_Cloud_API_Documentation_Token:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token'
    Acquia_Cloud_API_Documentation_TokenDeleteReason:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-delete-reason'
    Acquia_Cloud_API_Documentation_TokenUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-uuid'
    Acquia_Cloud_API_Documentation_UsageMetric:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_usage-metric'
    Acquia_Cloud_API_Documentation_UserSearch:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-search'
    Acquia_Cloud_API_Documentation_UserUuid:
      $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
    Acquia_Cloud_API_Documentation_agreement-uuid:
      description: The entity's universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: agreementUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_alert-uuid:
      description: The entity's universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: alertUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_apm-type:
      description: The APM type.
      example: newrelic
      in: path
      name: apmType
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_application-uuid:
      description: The entity's universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: applicationUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_artifact-id:
      description: An ID that uniquely identifies an artifact.
      example: drupal8
      in: path
      name: artifactId
      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_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_configuration-set-id:
      description: An ID that uniquely identifies a configuration set.
      example: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
      in: path
      name: configurationSetId
      required: true
      schema:
        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
    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_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_domain:
      description: A domain name.
      example: example.com
      in: path
      name: domain
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_domain-registration-uuid:
      description: The Domain Registration universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: domainRegistrationUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_drush-version:
      description: Specifies the drush aliases formatting, either 8 (example.aliases.drushrc.php)
        or 9 (example.site.yaml)
      example: 8
      in: query
      name: version
      required: true
      schema:
        enum:
        - 8
        - 9
        type: integer
    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_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_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_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_from:
      description: 'Specifies absolute time period to retrieve results from. Requires
        ISO 8601 format.


        Some examples:

        * `2023-09-01`

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

        '
      example: '2023-09-01'
      in: query
      name: from
      required: false
      schema:
        type: string
    Acquia_Cloud_API_Documentation_from-no-default:
      description: An ISO-8601 formatted date retrieve results from.
      example: '2021-01-29T22:45:21+00:00'
      in: query
      name: from
      required: false
      schema:
        type: string
    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_ide-uuid:
      description: The Cloud IDE universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: ideUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_identity-provider-uuid:
      description: The entity's universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: identityProviderUuid
      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_limit:
      description: The maximum number of items to return.
      example: 10
      in: query
      name: limit
      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_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_message-uuid:
      description: The entity's universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: messageUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_name:
      description: A name that uniquely identifies an entity.
      example: drupal8
      in: path
      name: name
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_notification-uuid:
      description: The entity's universally unique identifier.
      example: 2343b683-b194-4217-982a-6a95c72ad9a8
      in: path
      name: notificationUuid
      required: true
      schema:
        format: uuid
        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_organization-uuid:
      description: The organization entity's universally unique identifier.
      example: 1e7efab9-0fac-4a2c-ad94-61efc78623ba
      in: path
      name: organizationUuid
      required: true
      schema:
        format: uuid
        maxLength: 36
        minLength: 36
        type: string
    Acquia_Cloud_API_Documentation_permission:
      description: Specifies the permission you wish to check access for.
      example: deploy to prod
      in: query
      name: permission
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_range:
      description: ISO-8601 date/time of invite create date/time.
      in: query
      name: range
      required: false
      schema:
        format: date-time
        type: string
    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_role-uuid:
      description: The entity's universally unique identifier.
      example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
      in: path
      name: roleUuid
      required: true
      schema:
        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_server-type:
      description: Specifies the type of server metric to retrieve.
      example: web
      in: query
      name: serverType
      required: true
      schema:
        enum:
        - web
        - bal
        - db
        type: string
    Acquia_Cloud_API_Documentation_shield-acl-uuid:
      description: The entity's universally unique identifier.
      example: a1234567-1234-123a-abc1-12ab345cd678
      in: path
      name: shieldAclUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_site-id:
      description: The site id
      example: 1938d81b-4b14-462d-9871-5f8a32eb59b3
      in: path
      name: siteId
      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_ssh-key-uuid:
      description: The SSH key entity's universally unique identifier.
      example: 981b7910-2fe9-11e9-b210-d663bd873d93
      in: path
      name: sshKeyUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_stack-metrics-metric-type:
      description: Specifies the type of StackMetrics metric to retrieve.
      example:
      - web-cpu
      - web-memory
      in: path
      name: stackMetricsMetricType
      required: true
      schema:
        items:
          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
        type: array
    Acquia_Cloud_API_Documentation_subscription-uuid:
      description: The subscription entity's universally unique identifier.
      example: 0f3ad33e-2fe4-11e9-b210-d663bd873d93
      in: path
      name: subscriptionUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_tag-name:
      description: The name of the application tag.
      example: green
      in: path
      name: tagName
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_team-uuid:
      description: The entity's universally unique identifier.
      example: 3eef5d81-62f4-429c-aa94-e17d05ab4740
      in: path
      name: teamUuid
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_to:
      description: 'Optionally specifies absolute time period to retrieve results
        until. Requires ISO 8601 format.


        Some examples:

        * `2023-09-29`

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

        '
      example: '2023-09-29'
      in: query
      name: to
      required: false
      schema:
        type: string
    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_token:
      description: The token identifier.
      in: path
      name: token
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_token-delete-reason:
      description: Specifies the reason for the token revocation for future reference.
      example: The quick brown fox jumped over the lazy dog.
      in: query
      name: tokenDeleteReason
      schema:
        type: string
    Acquia_Cloud_API_Documentation_token-uuid:
      description: The token entity's universally unique identifier.
      example: 882f3258-2fe9-11e9-b210-d663bd873d93
      in: path
      name: tokenUuid
      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_user-search:
      description: The user's username, email, name, or token. This can be a partial
        match.
      example: john doe
      in: query
      name: userSearch
      required: true
      schema:
        type: string
    Acquia_Cloud_API_Documentation_user-uuid:
      description: The entity's universally unique identifier.
      example: f2daa9cc-e5a0-4036-a5c8-f96e336c62b5
      in: path
      name: userUuid
      required: true
      schema:
        type: string
    Private_Network_Service_API_Filter:
      description: 'Filter the result set using field-based criteria.


        **Format:** `field:value`, `field=value` or `field:operator:value`


        **Logical operators:**

        - `,` (comma) - OR logic between filters

        - `;` (semicolon) - AND logic between filters

        - **Note:** Cannot mix OR and AND operators in the same query


        **Comparison operators:**

        - `=` - Equals (default if no operator specified)

        - `!=` - Does not equal

        - `>` - Greater than

        - `<` - Less than

        - `>=` - Greater than or equal to

        - `<=` - Less than or equal to

        - `=@` - Contains substring

        - `!@` - Does not contain substring


        **Wildcards:**

        - `*` - Wildcard character for pattern matching


        **Examples:**

        - `status=active` - Filter by status equals active

        - `name=@prod` - Filter by name containing "prod"

        - `status=active;type=standard` - Status is active AND type is standard

        - `status=active,status=pending` - Status is active OR pending

        '
      example: status:active;type:standard
      in: query
      name: filter
      required: false
      schema:
        pattern: ^([a-zA-Z0-9_]+[:=](?:[a-zA-Z0-9_\-*]+|[><!@=%3D%3E%3C%3D@!%3D@]+)+)([;,][a-zA-Z0-9_]+[:=](?:[a-zA-Z0-9_\-*]+|[><!@=%3D%3E%3C%3D@!%3D@]+)+)*$
        type: string
    Private_Network_Service_API_Limit:
      description: The maximum number of items to return per page.
      in: query
      name: limit
      required: false
      schema:
        example: 10
        minimum: 1
        type: integer
    Private_Network_Service_API_Offset:
      description: The number of items to skip before starting to collect the result
        set.
      in: query
      name: offset
      required: false
      schema:
        example: 20
        minimum: 0
        type: integer
    Private_Network_Service_API_PrivateNetworkId:
      description: ID of the private network
      in: path
      name: privateNetworkId
      required: true
      schema:
        type: string
    Private_Network_Service_API_Sort:
      description: 'Sort the result set by one or more fields.


        **Format:** `field1,field2,-field3`


        **Sort order:**

        - No prefix - Ascending order (default)

        - `-` prefix - Descending order


        **Multiple fields:**

        - Fields are processed in the order specified

        - First field has highest priority

        - Use comma to separate multiple fields


        **Examples:**

        - `name` - Sort by name in ascending order

        - `-created_at` - Sort by created_at in descending order

        - `name,-created_at` - Sort by name ascending, then created_at descending

        - `status,name,-updated_at` - Sort by status ascending, then name ascending,
        then updated_at descending

        '
      example: name,-created_at
      in: query
      name: sort
      required: false
      schema:
        pattern: ^(-?[a-zA-Z0-9_]+)(,-?[a-zA-Z0-9_]+)*$
        type: string
    Private_Network_Service_API_SubscriptionId:
      description: ID of the subscription
      in: path
      name: subscriptionId
      required: true
      schema:
        type: string
    Private_Network_Service_API_VpcPeerId:
      description: ID of the VPC Peer
      in: path
      name: vpcPeerId
      required: true
      schema:
        type: integer
    Private_Network_Service_API_VpnId:
      description: ID of the VPN
      in: path
      name: vpnId
      required: true
      schema:
        type: integer
  requestBodies:
    Private_Network_Service_API_PrivateNetworkCreateRequest:
      content:
        application/json:
          schema:
            example:
              connections:
                cidr: 114.7.55.1/16
                private_egress_access:
                  drupal: true
                vpc_peers:
                - aws_account: '123456789012'
                  name: vpcPeer1
                  vpc_cidr: 120.24.16.1/24
                  vpc_id: vpc-1234567890abcdef0
                vpns:
                - gateway_ip: 10.10.10.10
                  name: vpn1
                  routes:
                  - 127.0.0.1/32
                  - 127.0.0.2/32
                  tunnel1:
                    dpd_timeout_action: stop
                    ike_versions: '1'
                    internal_cidr: 192.1.1.0/24
                    shared_key: sharedKey1
                    startup_action: start
                  tunnel2:
                    dpd_timeout_action: stop
                    ike_versions: '1'
                    internal_cidr: 192.1.1.0/14
                    shared_key: sharedKey2
                    startup_action: start
              description: Private network for customer
              ingress:
                drupal_ssh:
                  ingress_acls:
                  - test-acls
              isolation:
                dedicated_compute: false
                dedicated_network: false
              label: anyLabel
              name: customer-private-network
              region: us-east-1
              subscription_id: 123e4567-e89b-12d3-a456-426614174000
            properties:
              connections:
                $ref: '#/components/schemas/Private_Network_Service_API_Connections'
              description:
                type: string
              ingress:
                $ref: '#/components/schemas/Private_Network_Service_API_Ingress'
              isolation:
                $ref: '#/components/schemas/Private_Network_Service_API_Isolation'
              label:
                type: string
              name:
                type: string
              region:
                type: string
              subscription_id:
                type: string
            required:
            - subscription_id
            - region
            - name
            - connections
            type: object
      description: Private Network creation request body
  responses:
    Private_Network_Service_API_BadRequestError:
      content:
        application/json:
          example:
            error: bad_request
            message: The request was invalid or cannot be served. Check the request
              parameters and try again.
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_Error'
      description: Bad request
    Private_Network_Service_API_ConflictError:
      content:
        application/json:
          example:
            error: conflict
            message: The request could not be completed due to a conflict with the
              current state of the resource.
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_Error'
      description: Conflict
    Private_Network_Service_API_Connection:
      content:
        application/hal+json:
          example:
            _links:
              parent:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
              self:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections
            cidr: 1.1.1.1/11
            private_egress_access:
              drupal: true
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_ConnectionsResponse'
      description: Response for GET /private-networks/{privateNetworkId}/connections
      x-go-name: ConnectionGetResponse
    Private_Network_Service_API_ForbiddenError:
      content:
        application/json:
          example:
            error: forbidden
            message: You do not have permission to perform this action.
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_Error'
      description: Forbidden
    Private_Network_Service_API_Ingress:
      content:
        application/hal+json:
          example:
            _links:
              parent:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
              self:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/ingress
            drupal_ssh:
              ingress_acls:
              - test-acls
              private: false
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_IngressResponse'
      description: Ingress details
      x-go-name: IngressGetResponse
    Private_Network_Service_API_InternalServerError:
      content:
        application/json:
          example:
            error: system
            message: 'An unknown error occurred. Please try your request again. If
              the problem persists, contact Acquia Support. Request ID: abc123-def456-ghi789.'
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_Error'
      description: Internal server error
    Private_Network_Service_API_Isolation:
      content:
        application/hal+json:
          example:
            _links:
              parent:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
              self:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/isolation
            dedicated_compute: true
            dedicated_network: true
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_IsolationResponse'
      description: Response for GET /private-networks/{privateNetworkId}/isolation
      x-go-name: IsolationGetResponse
    Private_Network_Service_API_NotFoundError:
      content:
        application/json:
          example:
            error: not_found
            message: The requested resource could not be found.
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_Error'
      description: Resource not found
    Private_Network_Service_API_PrivateNetwork:
      content:
        application/hal+json:
          example:
            _links:
              connections:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections
              ingress:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/ingress
              isolation:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/isolation
              self:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000
              vpc_peers:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers
              vpns:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns
            created_at: '2023-10-01T12:00:00Z'
            description: Private network for NGC
            id: 123e4567-e89b-12d3-a456-426614174000
            label: ngc-private
            name: ngc-private-network
            region: us-east-1
            status: active
            subscription_id: 123e4567-e89b-12d3-a456-426614174000
            updated_at: '2023-10-01T12:00:00Z'
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_PrivateNetworkResponse'
      description: Response for GET /private-networks/{privateNetworkId}
      x-go-name: PrivateNetworkGetResponse
    Private_Network_Service_API_PrivateNetworkList:
      content:
        application/hal+json:
          schema:
            example:
              _embedded:
                items:
                - _links:
                    self:
                      href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
                  created_at: '2021-01-01T00:00:00Z'
                  description: Private network description
                  id: 456e4567-e89b-11d3-a789-426614174000
                  label: some label
                  name: test-private-network-1
                  region: us-east-1
                  status: active
                  subscription_id: 123e4567-e89b-12d3-a456-426614174000
                  updated_at: '2021-01-01T00:00:00Z'
                - _links:
                    self:
                      href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174001
                  created_at: '2021-01-01T00:00:00Z'
                  description: Private network description
                  id: 456e4567-e89b-11d3-a789-426614174001
                  label: some label
                  name: test-private-network-2
                  region: us-east-1
                  status: creating
                  subscription_id: 123e4567-e89b-12d3-a456-426614174000
                  updated_at: '2021-01-01T00:00:00Z'
              _links:
                self:
                  href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/private-networks
              count: 2
              total: 2
            properties:
              _embedded:
                $ref: '#/components/schemas/Private_Network_Service_API_EmbeddedPrivateNetworkList'
              _links:
                $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
              count:
                description: The total number of entries in this page
                type: integer
              total:
                description: The total number of entries available
                type: integer
            required:
            - count
            - total
            type: object
      description: List of private networks
      x-go-name: PrivateNetworkListResponse
    Private_Network_Service_API_UnauthorizedError:
      content:
        application/json:
          example:
            error: unauthorized
            message: You must be authenticated to access this resource.
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_Error'
      description: Unauthorized
    Private_Network_Service_API_VPNList:
      content:
        application/hal+json:
          example:
            _embedded:
              items:
              - gateway_ip: 1.1.1.1
                id: 1
                name: vpn1
                routes:
                - 1.1.1.1/12
            _links:
              self:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns
            count: 1
            total: 1
          schema:
            properties:
              _embedded:
                $ref: '#/components/schemas/Private_Network_Service_API_EmbeddedVPNList'
              _links:
                $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
              count:
                description: The total number of entries in this page
                type: integer
              total:
                description: The total number of entries available
                type: integer
            required:
            - count
            - total
            type: object
      description: List of VPNs in a private network
      x-go-name: VpnListResponse
    Private_Network_Service_API_ValidationError:
      content:
        application/hal+json:
          example:
            error: validation_failed
            message:
              another_field: Invalid value provided
              region: region is required
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_ValidationError'
      description: Validation failed
    Private_Network_Service_API_VpcPeer:
      content:
        application/hal+json:
          example:
            _links:
              parent:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
              self:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpc-peers/1
            aws_account: '123456789012'
            id: 1
            name: vpcPeer1
            peering_connection_id: pcx-1234567890abcdef0
            vpc_cidr: 120.24.16.1/24
            vpc_id: vpc-1234567890abcdef0
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_VPCPeersResponse'
      description: VPC Peer details
      x-go-name: VpcPeerGetResponse
    Private_Network_Service_API_VpcPeerList:
      content:
        application/hal+json:
          example:
            _embedded:
              items:
              - aws_account: '123456789012'
                id: 1
                name: vpcPeer1
                vpc_cidr: 10.0.0.0/16
                vpc_id: vpc-1234567890abcdef0
              - aws_account: '123456789012'
                id: 2
                name: vpcPeer2
                vpc_cidr: 10.0.0.0/16
                vpc_id: vpc-1234567890abcdef0
            _links:
              self:
                href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers
            count: 2
            total: 2
          schema:
            properties:
              _embedded:
                $ref: '#/components/schemas/Private_Network_Service_API_EmbeddedVPCPeerList'
              _links:
                $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
              count:
                description: The total number of entries in this page
                type: integer
              total:
                description: The total number of entries available
                type: integer
            required:
            - count
            - total
            type: object
      description: List of VPC Peers in a private network
      x-go-name: VpcPeerListResponse
    Private_Network_Service_API_Vpn:
      content:
        application/hal+json:
          example:
            _links:
              parent:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
              self:
                href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/test-vpn
            gateway_ip: 192.1.1.0
            id: 1
            name: test-vpn
            routes:
            - 192.1.1.0/14
            - 192.1.2.0/14
            tunnel1:
              address: 1.1.1.1
              dpd_timeout_action: stop
              ike_versions: '1'
              internal_cidr: 1.1.1.1/24
              shared_key: sharedKey1
              startup_action: start
            tunnel2:
              address: 1.1.1.1
              dpd_timeout_action: stop
              ike_versions: '2'
              internal_cidr: 1.1.1.1/24
              shared_key: sharedKey2
              startup_action: start
          schema:
            $ref: '#/components/schemas/Private_Network_Service_API_VPNResponse'
      description: VPN details
      x-go-name: VpnGetResponse
  schemas:
    Acquia_Cloud_API_Documentation_AccountInvites:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_account-invites'
    Acquia_Cloud_API_Documentation_Agreement:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_agreement'
    Acquia_Cloud_API_Documentation_Agreements:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_agreements'
    Acquia_Cloud_API_Documentation_Apm:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_apm'
    Acquia_Cloud_API_Documentation_ApmType:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_apm-type'
    Acquia_Cloud_API_Documentation_ApmTypes:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_apm-types'
    Acquia_Cloud_API_Documentation_Application:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application'
    Acquia_Cloud_API_Documentation_ApplicationDatabaseName:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-database-name'
    Acquia_Cloud_API_Documentation_ApplicationDatabases:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-databases'
    Acquia_Cloud_API_Documentation_ApplicationFeature:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-feature'
    Acquia_Cloud_API_Documentation_ApplicationFeatures:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-features'
    Acquia_Cloud_API_Documentation_ApplicationFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-flags'
    Acquia_Cloud_API_Documentation_ApplicationMetadata:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-metadata'
    Acquia_Cloud_API_Documentation_ApplicationNoEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-no-embedded'
    Acquia_Cloud_API_Documentation_ApplicationStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
    Acquia_Cloud_API_Documentation_ApplicationUsageMetric:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metric'
    Acquia_Cloud_API_Documentation_ApplicationUsageMetrics:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metrics'
    Acquia_Cloud_API_Documentation_Applications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications'
    Acquia_Cloud_API_Documentation_ApplicationsNotifications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-notifications'
    Acquia_Cloud_API_Documentation_ApplicationsPermissions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-permissions'
    Acquia_Cloud_API_Documentation_ApplicationsTasks:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-tasks'
    Acquia_Cloud_API_Documentation_ApplicationsTeams:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-teams'
    Acquia_Cloud_API_Documentation_Artifact:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact'
    Acquia_Cloud_API_Documentation_ArtifactStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact-stub'
    Acquia_Cloud_API_Documentation_Artifacts:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifacts'
    Acquia_Cloud_API_Documentation_AvailableRuntimes:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_available-runtimes'
    Acquia_Cloud_API_Documentation_Backup:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup'
    Acquia_Cloud_API_Documentation_BackupFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup-flags'
    Acquia_Cloud_API_Documentation_BackupNoEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backup-no-embedded'
    Acquia_Cloud_API_Documentation_Backups:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_backups'
    Acquia_Cloud_API_Documentation_CdeSize:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cde-size'
    Acquia_Cloud_API_Documentation_CdeSizes:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cde-sizes'
    Acquia_Cloud_API_Documentation_Cdn:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cdn'
    Acquia_Cloud_API_Documentation_CdnInformation:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cdn-information'
    Acquia_Cloud_API_Documentation_Certificate:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificate'
    Acquia_Cloud_API_Documentation_CertificateFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificate-flags'
    Acquia_Cloud_API_Documentation_CertificateSigningRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csr'
    Acquia_Cloud_API_Documentation_CertificateSigningRequestFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csr-flags'
    Acquia_Cloud_API_Documentation_CertificateSigningRequests:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_csrs'
    Acquia_Cloud_API_Documentation_Certificates:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_certificates'
    Acquia_Cloud_API_Documentation_CloudAction:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-action'
    Acquia_Cloud_API_Documentation_CloudActionId:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-action-id'
    Acquia_Cloud_API_Documentation_CloudActions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-actions'
    Acquia_Cloud_API_Documentation_CloudActionsFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cloud-actions-flags'
    Acquia_Cloud_API_Documentation_Code:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code'
    Acquia_Cloud_API_Documentation_CodeFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-flags'
    Acquia_Cloud_API_Documentation_CodeStudioApplication:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-application'
    Acquia_Cloud_API_Documentation_CodeStudioApplications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-applications'
    Acquia_Cloud_API_Documentation_CodeStudioOptions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-options'
    Acquia_Cloud_API_Documentation_CodeStudioProject:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-project'
    Acquia_Cloud_API_Documentation_CodeStudioProjectNoEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-project-no-embedded'
    Acquia_Cloud_API_Documentation_CodeStudioSubscriptionMetadata:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-subscription-metadata'
    Acquia_Cloud_API_Documentation_CodeStudioUser:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-user'
    Acquia_Cloud_API_Documentation_CodeStudioUsers:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-users'
    Acquia_Cloud_API_Documentation_Color:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_color'
    Acquia_Cloud_API_Documentation_Colors:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_colors'
    Acquia_Cloud_API_Documentation_ConfigurationSet:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-set'
    Acquia_Cloud_API_Documentation_ConfigurationSets:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-sets'
    Acquia_Cloud_API_Documentation_Cron:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cron'
    Acquia_Cloud_API_Documentation_CronFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cron-flags'
    Acquia_Cloud_API_Documentation_Crons:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_crons'
    Acquia_Cloud_API_Documentation_Database:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database'
    Acquia_Cloud_API_Documentation_DatabaseFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-flags'
    Acquia_Cloud_API_Documentation_DatabasePhpConfig:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-php-config'
    Acquia_Cloud_API_Documentation_DatabaseStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_database-stub'
    Acquia_Cloud_API_Documentation_Databases:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_databases'
    Acquia_Cloud_API_Documentation_DeployCodeRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_deploy-code'
    Acquia_Cloud_API_Documentation_Distribution:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_distribution'
    Acquia_Cloud_API_Documentation_Distributions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_distributions'
    Acquia_Cloud_API_Documentation_Dns:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns'
    Acquia_Cloud_API_Documentation_DnsRecord:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_dns-record'
    Acquia_Cloud_API_Documentation_Domain:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain'
    Acquia_Cloud_API_Documentation_DomainFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-flags'
    Acquia_Cloud_API_Documentation_DomainRegistration:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration'
    Acquia_Cloud_API_Documentation_DomainRegistrationDnsRecord:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration-dns-record'
    Acquia_Cloud_API_Documentation_DomainRegistrationDnsRecords:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration-dns-records'
    Acquia_Cloud_API_Documentation_DomainRegistrations:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registrations'
    Acquia_Cloud_API_Documentation_DomainStatus:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-status'
    Acquia_Cloud_API_Documentation_DomainStatusFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-status-flags'
    Acquia_Cloud_API_Documentation_Domains:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domains'
    Acquia_Cloud_API_Documentation_EIP:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_eip'
    Acquia_Cloud_API_Documentation_EIPFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_eip-flags'
    Acquia_Cloud_API_Documentation_EIPs:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_eips'
    Acquia_Cloud_API_Documentation_Email:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email'
    Acquia_Cloud_API_Documentation_EmailDomain:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email-domain'
    Acquia_Cloud_API_Documentation_EmailDomains:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email-domains'
    Acquia_Cloud_API_Documentation_EntitlementCde:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-cde'
    Acquia_Cloud_API_Documentation_EntitlementConsumptionBasedPricing:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-consumption-based-pricing'
    Acquia_Cloud_API_Documentation_EntitlementDefaultNewRelic:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-default-newrelic'
    Acquia_Cloud_API_Documentation_EntitlementLogForwarding:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-log-forwarding'
    Acquia_Cloud_API_Documentation_EntitlementPipelines:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-pipelines'
    Acquia_Cloud_API_Documentation_EntitlementShield:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-shield'
    Acquia_Cloud_API_Documentation_Entitlements:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlements'
    Acquia_Cloud_API_Documentation_Environment:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment'
    Acquia_Cloud_API_Documentation_EnvironmentConfigurations:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
    Acquia_Cloud_API_Documentation_EnvironmentFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-flags'
    Acquia_Cloud_API_Documentation_EnvironmentMetadata:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-metadata'
    Acquia_Cloud_API_Documentation_EnvironmentOptions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-options'
    Acquia_Cloud_API_Documentation_EnvironmentSettings:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-settings'
    Acquia_Cloud_API_Documentation_EnvironmentStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-stub'
    Acquia_Cloud_API_Documentation_EnvironmentUsageMetric:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-usage-metric'
    Acquia_Cloud_API_Documentation_EnvironmentUsageMetrics:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-usage-metrics'
    Acquia_Cloud_API_Documentation_EnvironmentVariable:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-variable'
    Acquia_Cloud_API_Documentation_EnvironmentVariables:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-variables'
    Acquia_Cloud_API_Documentation_Environments:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environments'
    Acquia_Cloud_API_Documentation_Error:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
    Acquia_Cloud_API_Documentation_File:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file'
    Acquia_Cloud_API_Documentation_FileDownload:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file-download'
    Acquia_Cloud_API_Documentation_HasPermission:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_has-permission'
    Acquia_Cloud_API_Documentation_Health:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
    Acquia_Cloud_API_Documentation_HostingSettings:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_hosting-settings'
    Acquia_Cloud_API_Documentation_Ide:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ide'
    Acquia_Cloud_API_Documentation_IdentityProvider:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_identity-provider'
    Acquia_Cloud_API_Documentation_IdentityProviders:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_identity-providers'
    Acquia_Cloud_API_Documentation_Ides:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ides'
    Acquia_Cloud_API_Documentation_ImportSiteRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_import-site'
    Acquia_Cloud_API_Documentation_Index:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_index'
    Acquia_Cloud_API_Documentation_Indexes:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_indexes'
    Acquia_Cloud_API_Documentation_Invite:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite'
    Acquia_Cloud_API_Documentation_InviteFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite-flags'
    Acquia_Cloud_API_Documentation_Invitees:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invitees'
    Acquia_Cloud_API_Documentation_IsAdministrator:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-administrator'
    Acquia_Cloud_API_Documentation_IsOwner:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-owner'
    Acquia_Cloud_API_Documentation_LegacyProductKeysSettings:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_legacy-product-keys-settings'
    Acquia_Cloud_API_Documentation_Links:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
    Acquia_Cloud_API_Documentation_Log:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log'
    Acquia_Cloud_API_Documentation_LogForwardingConsumer:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-consumer'
    Acquia_Cloud_API_Documentation_LogForwardingConsumers:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-consumers'
    Acquia_Cloud_API_Documentation_LogForwardingDestination:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination'
    Acquia_Cloud_API_Documentation_LogForwardingDestinationCredentials:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination-credentials'
    Acquia_Cloud_API_Documentation_LogForwardingDestinationFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destination-flags'
    Acquia_Cloud_API_Documentation_LogForwardingDestinations:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-destinations'
    Acquia_Cloud_API_Documentation_LogForwardingSource:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-source'
    Acquia_Cloud_API_Documentation_LogForwardingSources:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-sources'
    Acquia_Cloud_API_Documentation_Logs:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_logs'
    Acquia_Cloud_API_Documentation_Logstream:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_logstream'
    Acquia_Cloud_API_Documentation_Message:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
    Acquia_Cloud_API_Documentation_MessageWithLinks:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
    Acquia_Cloud_API_Documentation_Metrics:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_metrics'
    Acquia_Cloud_API_Documentation_ModProxy:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_mod-proxy'
    Acquia_Cloud_API_Documentation_Notification:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification'
    Acquia_Cloud_API_Documentation_NotificationLabels:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-labels'
    Acquia_Cloud_API_Documentation_NotificationStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-stub'
    Acquia_Cloud_API_Documentation_NotificationTasks:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-tasks'
    Acquia_Cloud_API_Documentation_OperatingSystems:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_operating-systems'
    Acquia_Cloud_API_Documentation_Organization:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization'
    Acquia_Cloud_API_Documentation_OrganizationAdminInvite:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-invite'
    Acquia_Cloud_API_Documentation_OrganizationAdminInvites:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-invites'
    Acquia_Cloud_API_Documentation_OrganizationAdminUserProfile:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profile'
    Acquia_Cloud_API_Documentation_OrganizationAdminUserProfiles:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profiles'
    Acquia_Cloud_API_Documentation_OrganizationApplications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-applications'
    Acquia_Cloud_API_Documentation_OrganizationAvailableTags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-available-tags'
    Acquia_Cloud_API_Documentation_OrganizationMembers:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-members'
    Acquia_Cloud_API_Documentation_OrganizationNoEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-no-embedded'
    Acquia_Cloud_API_Documentation_OrganizationStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
    Acquia_Cloud_API_Documentation_OrganizationStubEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub-embedded'
    Acquia_Cloud_API_Documentation_OrganizationTeamInvite:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-team-invite'
    Acquia_Cloud_API_Documentation_OrganizationTeamInvites:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-team-invites'
    Acquia_Cloud_API_Documentation_OrganizationTeamStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-team-stub'
    Acquia_Cloud_API_Documentation_OrganizationUserProfile:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-user-profile'
    Acquia_Cloud_API_Documentation_Organizations:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organizations'
    Acquia_Cloud_API_Documentation_OrganizationsNotifications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organizations-notifications'
    Acquia_Cloud_API_Documentation_Pagination:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_pagination'
    Acquia_Cloud_API_Documentation_PasswordRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_password'
    Acquia_Cloud_API_Documentation_PasswordValidation:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_password-validation'
    Acquia_Cloud_API_Documentation_Permission:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission'
    Acquia_Cloud_API_Documentation_PermissionFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission-flags'
    Acquia_Cloud_API_Documentation_Permissions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permissions'
    Acquia_Cloud_API_Documentation_PostCertificate:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-certificate'
    Acquia_Cloud_API_Documentation_PostCron:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-cron'
    Acquia_Cloud_API_Documentation_PostCsr:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-csr'
    Acquia_Cloud_API_Documentation_PostInvite:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-invite'
    Acquia_Cloud_API_Documentation_PutCloudActions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_put-cloud-actions'
    Acquia_Cloud_API_Documentation_PutCron:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_put-cron'
    Acquia_Cloud_API_Documentation_RemoteAdministration:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration'
    Acquia_Cloud_API_Documentation_RemoteAdministrationSettings:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration-settings'
    Acquia_Cloud_API_Documentation_ResourceTag:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag'
    Acquia_Cloud_API_Documentation_ResourceTagEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag-embedded'
    Acquia_Cloud_API_Documentation_ResourceTagOrganization:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag-organization'
    Acquia_Cloud_API_Documentation_ResourceTags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tags'
    Acquia_Cloud_API_Documentation_Role:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role'
    Acquia_Cloud_API_Documentation_RoleStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role-stub'
    Acquia_Cloud_API_Documentation_Roles:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_roles'
    Acquia_Cloud_API_Documentation_Root:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_root'
    Acquia_Cloud_API_Documentation_Search:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_search'
    Acquia_Cloud_API_Documentation_SecuritySettings:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_security-settings'
    Acquia_Cloud_API_Documentation_Server:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server'
    Acquia_Cloud_API_Documentation_ServerConfiguration:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server-configuration'
    Acquia_Cloud_API_Documentation_ServerFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server-flags'
    Acquia_Cloud_API_Documentation_ServerStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_server-stub'
    Acquia_Cloud_API_Documentation_Servers:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_servers'
    Acquia_Cloud_API_Documentation_Settings:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_settings'
    Acquia_Cloud_API_Documentation_ShieldAcl:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_shield-acl'
    Acquia_Cloud_API_Documentation_ShieldAclCollection:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_shield-acl-collection'
    Acquia_Cloud_API_Documentation_SshKey:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-key'
    Acquia_Cloud_API_Documentation_SshKeyRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-key-request'
    Acquia_Cloud_API_Documentation_SshKeys:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-keys'
    Acquia_Cloud_API_Documentation_Ssl:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssl'
    Acquia_Cloud_API_Documentation_StackMetricsData:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_stack-metrics-data'
    Acquia_Cloud_API_Documentation_StackMetricsMetric:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_stack-metrics-metric'
    Acquia_Cloud_API_Documentation_Subscription:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription'
    Acquia_Cloud_API_Documentation_SubscriptionApplications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-applications'
    Acquia_Cloud_API_Documentation_SubscriptionFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-flags'
    Acquia_Cloud_API_Documentation_SubscriptionMetadata:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-metadata'
    Acquia_Cloud_API_Documentation_SubscriptionStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub'
    Acquia_Cloud_API_Documentation_SubscriptionStubEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub-embedded'
    Acquia_Cloud_API_Documentation_SubscriptionUsageMetric:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-usage-metric'
    Acquia_Cloud_API_Documentation_SubscriptionUsageMetrics:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-usage-metrics'
    Acquia_Cloud_API_Documentation_Subscriptions:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscriptions'
    Acquia_Cloud_API_Documentation_SwitchCodeRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_switch-code'
    Acquia_Cloud_API_Documentation_Task:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_task'
    Acquia_Cloud_API_Documentation_Team:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team'
    Acquia_Cloud_API_Documentation_TeamApplications:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-applications'
    Acquia_Cloud_API_Documentation_TeamInvites:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-invites'
    Acquia_Cloud_API_Documentation_TeamMembers:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-members'
    Acquia_Cloud_API_Documentation_TeamStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-stub'
    Acquia_Cloud_API_Documentation_TeamUserProfile:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-user-profile'
    Acquia_Cloud_API_Documentation_Teams:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_teams'
    Acquia_Cloud_API_Documentation_Token:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token'
    Acquia_Cloud_API_Documentation_TokenCreation:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token-creation'
    Acquia_Cloud_API_Documentation_TokenRequest:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token-request'
    Acquia_Cloud_API_Documentation_Tokens:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_tokens'
    Acquia_Cloud_API_Documentation_Usage:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_usage'
    Acquia_Cloud_API_Documentation_User:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user'
    Acquia_Cloud_API_Documentation_UserFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-flags'
    Acquia_Cloud_API_Documentation_UserProfile:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-profile'
    Acquia_Cloud_API_Documentation_UserStub:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
    Acquia_Cloud_API_Documentation_UserStubEmbedded:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub-embedded'
    Acquia_Cloud_API_Documentation_UserStubNullable:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub-nullable'
    Acquia_Cloud_API_Documentation_UxMessage:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message'
    Acquia_Cloud_API_Documentation_UxMessageFilters:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-filters'
    Acquia_Cloud_API_Documentation_UxMessageFlags:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-flags'
    Acquia_Cloud_API_Documentation_UxMessages:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-messages'
    Acquia_Cloud_API_Documentation_ValidationError:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
    Acquia_Cloud_API_Documentation_Vcs:
      $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_vcs'
    Acquia_Cloud_API_Documentation_account-invites:
      description: A collection of invites.
      properties:
        _embedded:
          description: A collection of invites matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite'
              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_agreement:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        actioned_by:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub-nullable'
        body:
          description: The formatted agreement content.
          type: string
        created_at:
          description: The date the agreement was created.
          format: date-time
          type: string
        document_uuid:
          description: The agreement document UUID.
          format: uuid
          type: string
        reference:
          description: A reference to the entity for this agreement.
          properties:
            name:
              description: The entity name.
              type: string
            type:
              description: The entity type.
              type: string
            uuid:
              description: The entity UUID.
              format: uuid
              type: string
          type: object
        status:
          description: The status of the agreement.
          enum:
          - pending
          - accepted
          - declined
          type: string
        title:
          description: The name of the agreement.
          type: string
        updated_at:
          description: The date the agreement was last updated.
          format: date-time
          nullable: true
          type: string
        uuid:
          description: The agreement UUID.
          format: uuid
          type: string
      required:
      - uuid
      - document_uuid
      - title
      - body
      - status
      - created_at
      - updated_at
      - actioned_by
      - reference
      - _links
      type: object
    Acquia_Cloud_API_Documentation_agreements:
      properties:
        _embedded:
          description: A collection of agreements matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_agreement'
              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_apm:
      description: Details application performance monitor settings.
      properties:
        _embedded:
          description: Entities related to the APM settings.
          properties:
            environment:
              description: An array of links to related environments.
              items:
                properties:
                  _links:
                    $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
                type: object
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        flags:
          description: An array of flags for an APM.
          properties:
            enabled:
              description: Whether or not the APM is enabled.
              type: boolean
          type: object
        key:
          description: The APM license key.
          type: string
        name:
          description: The APM application name. New Relic only.
          type: string
        type:
          description: Indicates the APM type.
          type: string
      required:
      - type
      - key
      - name
      - flags
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_apm-type:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        flags:
          description: Additional APM information.
          properties:
            opted-in:
              description: Whether the organization owner has opted into the APM type.
              type: boolean
          type: object
        key:
          description: The APM license key.
          type: string
        type:
          description: The APM type.
          enum:
          - newrelic
          type: string
      required:
      - type
      - flags
      - key
      - _links
      type: object
    Acquia_Cloud_API_Documentation_apm-types:
      properties:
        _embedded:
          description: A collection of APM types matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_apm-type'
              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_application:
      properties:
        _embedded:
          description: Entities related to the application.
          properties:
            organization:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub-embedded'
            subscription:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub-embedded'
            tags:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag-embedded'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-flags'
        hosting:
          description: Hosting details for this application.
          properties:
            id:
              description: The hosting ID.
              type: string
            type:
              description: The hosting type.
              enum:
              - ace
              - acp
              - acsf
              - free
              - network
              - search
              - unknown
              type: string
          type: object
        id:
          description: The unique internal ID of the application.
          type: integer
        name:
          description: The name of the application.
          type: string
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        status:
          description: The current application status.
          enum:
          - normal
          - provisioning
          type: string
        subscription:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub'
        type:
          description: The type of application supported.
          enum:
          - drupal
          - node
          - ssg
          type: string
        uuid:
          description: The UUID of the application.
          format: uuid
          type: string
      required:
      - id
      - uuid
      - name
      - hosting
      - subscription
      - organization
      - flags
      - type
      - status
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_application-database-name:
      description: Application database name.
      properties:
        name:
          description: The database name.
          maxLength: 63
          minLength: 1
          type: string
      required:
      - name
      type: object
    Acquia_Cloud_API_Documentation_application-databases:
      description: Collection of application databases.
      properties:
        _embedded:
          description: A collection of database names matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-database-name'
              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_application-feature:
      properties:
        description:
          description: A description of the feature flag.
          type: string
        label:
          description: The feature flag friendly name.
          type: string
        name:
          description: The feature flag machine name.
          type: string
      required:
      - name
      - label
      - description
      type: object
    Acquia_Cloud_API_Documentation_application-features:
      properties:
        _embedded:
          description: A collection of application feature flags.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-feature'
              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_application-flags:
      description: An array of various flags that indicate functionality associated
        with applications.
      properties:
        remote_admin:
          description: Whether this application has remote administration enabled.
          type: boolean
      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_application-no-embedded:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-flags'
        hosting:
          description: Hosting details for this application.
          properties:
            id:
              description: The hosting ID.
              type: string
            type:
              description: The hosting type.
              enum:
              - ace
              - acp
              - acsf
              - free
              - network
              - search
              - unknown
              type: string
          type: object
        id:
          description: The unique internal ID of the application.
          type: integer
        name:
          description: The name of the application.
          type: string
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        status:
          description: The current application status.
          enum:
          - normal
          - provisioning
          type: string
        subscription:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub'
        type:
          description: The type of application supported.
          enum:
          - drupal
          - node
          - ssg
          type: string
        uuid:
          description: The UUID of the application.
          format: uuid
          type: string
      required:
      - id
      - uuid
      - name
      - hosting
      - subscription
      - organization
      - flags
      - type
      - status
      - _links
      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_application-usage-metric:
      description: Provides details about views and visits for an application.
      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
          nullable: true
          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_application-usage-metrics:
      description: A collection of application usage metrics.
      properties:
        _embedded:
          description: A collection of application metric items matching the request
            parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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_applications:
      properties:
        _embedded:
          description: A collection of applications.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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
      type: object
    Acquia_Cloud_API_Documentation_applications-notifications:
      properties:
        _embedded:
          description: A collection of notifications matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-stub'
              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_applications-permissions:
      properties:
        _embedded:
          description: A collection of permissions matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        flags:
          description: Additional information about the permissions.
          properties:
            administrator:
              description: Whether the current user is able to administrate the application.
              type: boolean
          required:
          - administrator
          type: object
        total:
          description: The number of items returned in the collection.
          type: integer
      required:
      - total
      - flags
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_applications-tasks:
      properties:
        _embedded:
          description: A collection of tasks matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_task'
              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_applications-teams:
      properties:
        _embedded:
          description: A collection of teams matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team'
              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_artifact:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        created_at:
          description: The time at which the artifact was created.
          format: date-time
          type: string
        id:
          description: The unique ID of the artifact.
          type: integer
        name:
          description: The name of the artifact.
          type: string
        state:
          description: The state of the artifact.
          enum:
          - delete-failed
          - deleted
          - pending-delete
          - pending-upload
          - ready
          - upload-failed
          type: string
      required:
      - id
      - name
      - state
      - created_at
      - _links
      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_artifacts:
      properties:
        _embedded:
          description: A collection of artifacts.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact'
              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_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_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_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_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_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_cde-size:
      description: Response schema for a CDE size.
      properties:
        databases:
          description: Number of databases available.
          type: integer
        memory:
          description: The CDE memory in MB.
          type: integer
        name:
          description: The CDE size name.
          type: string
        size:
          description: The CDE size.
          type: string
        slots:
          description: Number of slots available.
          type: integer
        storage:
          description: The CDE storage in GB.
          type: integer
      required:
      - name
      - size
      - memory
      - storage
      - databases
      - slots
      type: object
    Acquia_Cloud_API_Documentation_cde-sizes:
      properties:
        _embedded:
          description: The collection of CDE sizes.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_cde-size'
              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_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_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_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_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_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_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_cloud-action-id:
      description: A Cloud Action ID.
      format: uuid
      type: string
    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_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_code:
      properties:
        _embedded:
          description: A collection of branch and tag information.
          properties:
            items:
              items:
                properties:
                  flags:
                    $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-flags'
                  name:
                    description: The name of the branch or tag.
                    type: string
                required:
                - name
                - flags
                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_code-flags:
      description: An array of various flags that indicate functionality associated
        with code branches and tags on applications.
      properties:
        tag:
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_code-studio-application:
      description: The model for a Code Studio application.
      properties:
        _embedded:
          description: An associated code studio project.
          properties:
            project:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-project-no-embedded'
          type: object
        _links:
          description: Links to Code Studio project and API.
          properties:
            parent:
              description: A link to the parent page.
              properties:
                href:
                  description: The URI for the parent page.
                  format: uri
                  type: string
              required:
              - href
              type: object
            project:
              description: A link to code studio project.
              properties:
                href:
                  description: The URI for the code studio project.
                  format: uri
                  type: string
              required:
              - href
              type: object
            self:
              description: A link to this page.
              properties:
                href:
                  description: The URI for this page.
                  format: uri
                  type: string
              required:
              - href
              type: object
          type: object
        name:
          description: The application name.
          type: string
        uuid:
          description: The unique identifier of the application.
          format: uuid
          type: string
      required:
      - uuid
      - name
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_code-studio-applications:
      description: A collection of applications with associated Code Studio projects
        for a subscription.
      properties:
        _embedded:
          description: A collection of Code Studio enabled applications.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-application'
              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
      required:
      - total
      - pagination
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_code-studio-options:
      description: Code Studio options.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        roles:
          additionalProperties:
            type: string
          type: object
      type: object
    Acquia_Cloud_API_Documentation_code-studio-project:
      description: The model for a Code Studio project.
      properties:
        _embedded:
          description: Contains the embedded Acquia Cloud user.
          properties:
            application:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        application_id:
          description: The associated application id.
          format: uuid
          type: string
        status:
          description: The status of the GitLab project
          enum:
          - active
          - inactive
          - installing
          - install-failed
          - deleted
          - deleting
          - delete-failed
          type: string
      required:
      - application_id
      - status
      - _embedded
      - _links
      type: object
    Acquia_Cloud_API_Documentation_code-studio-project-no-embedded:
      description: The model for a Code Studio project.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        application_id:
          description: The associated application id.
          format: uuid
          type: string
        status:
          description: The status of the GitLab project
          enum:
          - active
          - inactive
          - installing
          - install-failed
          - deleted
          - deleting
          - delete-failed
          type: string
      required:
      - application_id
      - status
      - _links
      type: object
    Acquia_Cloud_API_Documentation_code-studio-subscription-metadata:
      description: The Code Studio status for a subscription.
      properties:
        status:
          description: A status indicating whether Code Studio has been enabled for
            the subscription.
          enum:
          - active
          - installing
          - install-failed
          - deleted
          - deleting
          - delete-failed
          type: string
      required:
      - status
      type: object
    Acquia_Cloud_API_Documentation_code-studio-user:
      description: The model for a Code Studio user.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        first_name:
          description: The user's first name.
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        role:
          description: The GitLab role for the user.
          format: uuid
          type: string
        uuid:
          description: The Acquia Cloud user UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - mail
      - role
      - _links
      type: object
    Acquia_Cloud_API_Documentation_code-studio-users:
      description: A collection of users for a subscription with assigned seats for
        Code Studio.
      properties:
        _embedded:
          description: A collection of Code Studio enabled users.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-user'
              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_color:
      description: Response schema for a color.
      properties:
        color:
          description: The color name.
          type: string
      required:
      - color
      type: object
    Acquia_Cloud_API_Documentation_colors:
      properties:
        _embedded:
          description: The collection of colors.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_color'
              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_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_configuration-sets:
      description: A collection of configuration sets.
      properties:
        _embedded:
          description: A collection of configuration sets.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-set'
              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_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_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_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_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_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_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_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_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_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_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_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_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_distribution:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        description:
          description: The verbose description of the distribution.
          type: string
        drupal_version:
          description: The Drupal version string of the distribution.
          type: string
        flags:
          description: Flags for this distribution.
          properties:
            default:
              description: Whether this distribution is the default.
              type: boolean
          type: object
        image_url:
          description: The URI for the logo image for this distribution.
          format: uri
          type: string
        name:
          description: The name of the distribution.
          type: string
        title:
          description: The title of the distribution.
          type: string
        update_urls:
          description: The update URLs for the distribution.
          properties:
            gz:
              description: The URI for the gzip compressed update.
              format: uri
              type: string
            zip:
              description: The URI for the zip compressed update.
              format: uri
              type: string
          type: object
        urls:
          description: The URLs for the distribution.
          properties:
            gz:
              description: The URI for the gzip compressed distribution.
              format: uri
              type: string
            zip:
              description: The URI for the zip compressed distribution.
              format: uri
              type: string
          type: object
        version:
          description: The full version string of the distribution.
          type: string
      required:
      - name
      - urls
      - update_urls
      - title
      - version
      - drupal_version
      - description
      - image_url
      - flags
      - _links
      type: object
    Acquia_Cloud_API_Documentation_distributions:
      properties:
        _embedded:
          description: A collection of distributions.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_distribution'
              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_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_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_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_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_domain-registration:
      description: The Domain Registration.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        dns_records:
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration-dns-records'
          type: array
        domain_name:
          description: The domain name.
          format: hostname
          type: string
        health:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
        uuid:
          description: The UUID of the domain registration.
          format: uuid
          type: string
      required:
      - uuid
      - domain_name
      - health
      - dns_records
      - _links
      type: object
    Acquia_Cloud_API_Documentation_domain-registration-dns-record:
      description: A DNS record.
      properties:
        health:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
        name:
          description: The name of the DNS record
          type: string
        type:
          description: The type of DNS record.
          enum:
          - TXT
          - MX
          - CNAME
          type: string
        value:
          description: The DNS record value.
          type: string
      required:
      - type
      - value
      type: object
    Acquia_Cloud_API_Documentation_domain-registration-dns-records:
      properties:
        _embedded:
          description: A collection of DNS records
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration-dns-record'
              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_domain-registrations:
      properties:
        _embedded:
          description: A collection of domain registrations.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration'
              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_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_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_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_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_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_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_email:
      description: The Email status.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        status:
          description: The status of Platform Email for the environment
          enum:
          - active
          - inactive
          type: string
      required:
      - status
      - _links
      type: object
    Acquia_Cloud_API_Documentation_email-domain:
      description: The Email Domain
      properties:
        domain_name:
          description: The domain name.
          format: hostname
          type: string
        flags:
          description: Additional Email Domain information.
          properties:
            associated:
              description: Whether or not Platform Email has been associated with
                the application.
              type: boolean
          type: object
        health:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
        uuid:
          description: The UUID of the email domain.
          format: uuid
          type: string
      required:
      - uuid
      - domain_name
      - flags
      - health
      type: object
    Acquia_Cloud_API_Documentation_email-domains:
      properties:
        _embedded:
          description: A collection of email domains.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email-domain'
              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_entitlement-cde:
      description: Continuous delivery environment entitlement.
      properties:
        expires_at:
          description: The furthest expiration date.
          type: string
        flags:
          description: The flags associated with the entitlement.
          properties:
            trial:
              description: Determines if the entitlement is a trial.
              type: boolean
          type: object
        name:
          description: The name of the entitlement.
          type: string
        offering_ids:
          description: The offering IDs associated with the entitlement.
          items:
            type: string
          type: array
        properties:
          description: Entitlement data.
          properties:
            databases_total:
              description: The number of on-demand environment databases granted.
              type: integer
            total:
              description: The number of on-demand environments granted.
              type: integer
            used:
              description: The number of on-demand environments used.
              type: integer
          type: object
      required:
      - name
      - offering_ids
      - expires_at
      - flags
      - properties
      type: object
    Acquia_Cloud_API_Documentation_entitlement-consumption-based-pricing:
      description: Consumption based pricing entitlement.
      properties:
        expires_at:
          description: The furthest expiration date.
          type: string
        flags:
          description: The flags associated with the entitlement.
          properties:
            trial:
              description: Determines if the entitlement is a trial.
              type: boolean
          type: object
        name:
          description: The name of the entitlement.
          type: string
        offering_ids:
          description: The offering IDs associated with the entitlement.
          items:
            type: string
          type: array
        properties:
          description: Entitlement data.
          properties:
            views:
              description: The maximum number of allowed views.
              type: integer
            visits:
              description: The maximum number of allowed unique visits.
              type: integer
          type: object
      required:
      - name
      - offering_ids
      - expires_at
      - flags
      - properties
      type: object
    Acquia_Cloud_API_Documentation_entitlement-default-newrelic:
      description: Represents the default New Relic account. The default New Relic
        account is created when a subscription is provisioned.
      properties:
        expires_at:
          description: The furthest expiration date.
          type: string
        flags:
          description: The flags associated with the entitlement.
          properties:
            trial:
              description: Determines if the entitlement is a trial.
              type: boolean
          type: object
        name:
          description: The name of the entitlement.
          type: string
        offering_ids:
          description: The offering IDs associated with the entitlement.
          items:
            type: string
          type: array
        properties:
          description: Entitlement data.
          properties:
            id:
              description: The New Relic account identifier.
              type: string
            level:
              description: The New Relic account level.
              enum:
              - pro
              type: string
          type: object
      required:
      - name
      - offering_ids
      - expires_at
      - flags
      - properties
      type: object
    Acquia_Cloud_API_Documentation_entitlement-log-forwarding:
      description: Log forwarding entitlement.
      properties:
        expires_at:
          description: The furthest expiration date.
          type: string
        flags:
          description: The flags associated with the entitlement.
          properties:
            trial:
              description: Determines if the entitlement is a trial.
              type: boolean
          type: object
        name:
          description: The name of the entitlement.
          type: string
        offering_ids:
          description: The offering IDs associated with the entitlement.
          items:
            type: string
          type: array
      required:
      - name
      - offering_ids
      - expires_at
      - flags
      type: object
    Acquia_Cloud_API_Documentation_entitlement-pipelines:
      description: Pipelines entitlement.
      properties:
        expires_at:
          description: The furthest expiration date.
          type: string
        flags:
          description: The flags associated with the entitlement.
          properties:
            trial:
              description: Determines if the entitlement is a trial.
              type: boolean
          type: object
        name:
          description: The name of the entitlement.
          type: string
        offering_ids:
          description: The offering IDs associated with the entitlement.
          items:
            type: string
          type: array
      required:
      - name
      - offering_ids
      - expires_at
      - flags
      type: object
    Acquia_Cloud_API_Documentation_entitlement-shield:
      description: Shield entitlement.
      properties:
        expires_at:
          description: The furthest expiration date.
          type: string
        flags:
          description: The flags associated with the entitlement.
          properties:
            trial:
              description: Determines if the entitlement is a trial.
              type: boolean
          type: object
        name:
          description: The name of the entitlement.
          type: string
        offering_ids:
          description: The offering IDs associated with the entitlement.
          items:
            type: string
          type: array
      required:
      - name
      - offering_ids
      - expires_at
      - flags
      type: object
    Acquia_Cloud_API_Documentation_entitlements:
      description: Entitlements collection.
      properties:
        _embedded:
          description: A collection of entitlements.
          properties:
            items:
              items:
                anyOf:
                - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-pipelines'
                - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-cde'
                - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-consumption-based-pricing'
                - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-log-forwarding'
                - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-shield'
                - $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlement-default-newrelic'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_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_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_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_environment-metadata:
      description: Environment metadata.
      properties:
        ids:
          description: An array of environment identifiers.
          items:
            type: string
          type: array
      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_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_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_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_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_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_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_environments:
      properties:
        _embedded:
          description: A collection of environments matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment'
              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_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_file:
      description: A binary file response.
      format: binary
      type: string
    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_has-permission:
      description: Determines if a user account has a specific permission.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        access:
          description: Whether or not the user account has the specific permission.
          type: boolean
      required:
      - access
      - _links
      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_hosting-settings:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        hosting_id:
          description: The application's hosting identifier.
          type: string
        type:
          description: The application's hosting type.
          type: string
        uuid:
          description: The application UUID.
          format: uuid
          type: string
      type: object
    Acquia_Cloud_API_Documentation_ide:
      properties:
        _embedded:
          properties:
            owner:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-profile'
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        label:
          description: The human-friendly label of the Cloud IDE.
          type: string
        status:
          description: The current provisioning status of the Cloud IDE.
          enum:
          - active
          - provisioning
          - deleting
          - updating
          - provision-failed
          - update-failed
          - delete-failed
          type: string
        uuid:
          description: The unique identifier of the Cloud IDE.
          format: uuid
          type: string
      required:
      - uuid
      - label
      - status
      - _links
      type: object
    Acquia_Cloud_API_Documentation_identity-provider:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        certificate:
          description: The PEM-encoded X.509 certificate used to sign assertions.
          type: string
        idp_entity_id:
          description: The SAML entity ID of the identity provider.
          type: string
        label:
          description: The human-friendly label of the identity provider.
          type: string
        sp_entity_id:
          description: The SAML entity ID of the service provider.
          type: string
        sso_url:
          description: The URL of the SAML POST Binding / SP-initiated SSO.
          format: uri
          type: string
        status:
          description: The current state of the identity provider.
          enum:
          - enabled
          - incomplete
          - disabled
          type: string
        uuid:
          description: The unique identifier of the identity provider.
          format: uuid
          type: string
      required:
      - uuid
      - label
      - idp_entity_id
      - sp_entity_id
      - sso_url
      - certificate
      - status
      - _links
      type: object
    Acquia_Cloud_API_Documentation_identity-providers:
      properties:
        _embedded:
          description: A collection of identity providers matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_identity-provider'
              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_ides:
      properties:
        _embedded:
          description: A collection of Cloud IDEs matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ide'
              type: array
          required:
          - items
          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_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_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_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_invite:
      description: Details an invite.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        applications:
          description: List of applications the invite will grant the invitee.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
          type: array
        author:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        created_at:
          description: The invite creation time.
          format: date-time
          type: string
        email:
          description: The invitee email address.
          format: email
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite-flags'
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        roles:
          description: List of roles the invite will grant the invitee.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role-stub'
          type: array
        team:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-stub'
        token:
          description: The invite token.
          type: string
        uuid:
          description: The unique identifier of the Invite.
          format: uuid
          type: string
      required:
      - uuid
      - email
      - created_at
      - token
      - flags
      - author
      - _links
      type: object
    Acquia_Cloud_API_Documentation_invite-flags:
      description: An array of various flags providing more context for the Invite
        response object.
      properties:
        declined:
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_invitees:
      properties:
        _embedded:
          description: A collection of invitees matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
              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_is-administrator:
      description: Determines if a user account is an administrator.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        admin:
          description: Whether or not the user account is an administrator.
          type: boolean
      required:
      - admin
      - _links
      type: object
    Acquia_Cloud_API_Documentation_is-owner:
      description: Determines if a user account is an owner.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        owner:
          description: Whether or not the user account is an owner.
          type: boolean
      required:
      - owner
      - _links
      type: object
    Acquia_Cloud_API_Documentation_legacy-product-keys-settings:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        acquia_connector:
          description: Acquia Connector legacy credentials.
          properties:
            identifier:
              description: The Acquia Connector site identifier.
              type: string
            key:
              description: The Acquia Connector key.
              type: string
          type: object
        cloud_api:
          description: Cloud API legacy credentials.
          properties:
            key:
              description: The Cloud API key.
              type: string
            username:
              description: The Cloud API username (Subscription UUID).
              format: uuid
              type: string
          type: object
      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
    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_log-forwarding-consumer:
      description: Response schema for a Log forwarding consumer.
      properties:
        label:
          description: The consumer label.
          type: string
        name:
          description: The consumer name.
          type: string
      required:
      - name
      - label
      type: object
    Acquia_Cloud_API_Documentation_log-forwarding-consumers:
      properties:
        _embedded:
          description: The collection of Log forwarding consumers.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-consumer'
              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-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_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_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_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_log-forwarding-source:
      description: Response schema for a Log forwarding source.
      properties:
        label:
          description: The source label.
          type: string
        name:
          description: The source name.
          type: string
        platforms:
          description: List of platforms for which the source is available.
          items:
            description: The platform name.
            type: string
          type: array
      required:
      - name
      - label
      - platforms
      type: object
    Acquia_Cloud_API_Documentation_log-forwarding-sources:
      properties:
        _embedded:
          description: The collection of Log forwarding sources.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_log-forwarding-source'
              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_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_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_message:
      properties:
        message:
          description: A simple message returned from the response.
          type: string
      required:
      - message
      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_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_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_notification:
      description: A notification about an event or a task.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        completed_at:
          description: The time that the task or event this notification is tracking
            was completed at.
          format: date-time
          type: string
        created_at:
          description: The time that this notification was created.
          format: date-time
          type: string
        description:
          description: The notification description.
          type: string
        labels:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-labels'
        metadata:
          description: A collection of metadata related to the notification.
          properties:
            environments:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-metadata'
          type: object
        name:
          description: The notification name.
          type: string
        progress:
          description: The notification progress.
          maximum: 100
          minimum: 0
          type: integer
        started_at:
          description: The time that the task or event this notification is tracking
            was started at.
          format: date-time
          type: string
        status:
          description: The status of the notification.
          enum:
          - completed
          - in-progress
          - failed
          type: string
        title:
          description: The operation title.
          type: string
        type:
          description: The notification type.
          enum:
          - task
          - event
          type: string
        user:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        uuid:
          description: The notification unique identifier.
          format: uuid
          type: string
      required:
      - progress
      - user
      - uuid
      - name
      - title
      - description
      - created_at
      - started_at
      - completed_at
      - status
      - type
      - metadata
      - labels
      - _links
      type: object
    Acquia_Cloud_API_Documentation_notification-labels:
      description: An array of various labels associated with a notification.
      items:
        description: Contextual information regarding the notification.
        type: string
      type: array
    Acquia_Cloud_API_Documentation_notification-stub:
      description: A notification about an event or a task.
      properties:
        _embedded:
          description: Data related to the notification, such as the author.
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        completed_at:
          description: The time that the task or event this notification is tracking
            was completed at.
          format: date-time
          type: string
        context:
          description: Contextual data related to the notification.
          type: object
        created_at:
          description: The time that this notification was created.
          format: date-time
          type: string
        description:
          description: The notification description.
          type: string
        event:
          description: The notification event.
          type: string
        label:
          description: The human readable notification label.
          type: string
        progress:
          description: The notification progress.
          maximum: 100
          minimum: 0
          type: integer
        status:
          description: The status of the notification.
          enum:
          - completed
          - in-progress
          - failed
          type: string
        uuid:
          description: The notification unique identifier.
          format: uuid
          type: string
      required:
      - uuid
      - event
      - label
      - description
      - created_at
      - completed_at
      - status
      - progress
      - context
      - _links
      type: object
    Acquia_Cloud_API_Documentation_notification-tasks:
      properties:
        _embedded:
          description: A collection of tasks matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_task'
              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_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_organization:
      description: Organization information.
      properties:
        _embedded:
          description: Entities related to the organization.
          properties:
            owner:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub-embedded'
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        admins_total:
          description: The number of administrators this organization has.
          type: integer
        flags:
          description: An array of various flags that indicate functionality for the
            organization.
          properties:
            federated_authentication:
              description: Indicates whether the organization supports federated authentication.
              type: boolean
          type: object
        id:
          description: The internal ID of the organization.
          type: string
        name:
          description: The name of the organization.
          type: string
        owner:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        roles_total:
          description: The number of roles this organization has.
          type: integer
        subscriptions_total:
          description: The number of subscriptions this organization has.
          type: integer
        teams_total:
          description: The number of teams this organization has.
          type: integer
        users_total:
          description: The number of users this organization has.
          type: integer
        uuid:
          description: The UUID of the organization.
          type: string
      required:
      - id
      - uuid
      - name
      - subscriptions_total
      - admins_total
      - users_total
      - teams_total
      - roles_total
      - owner
      - flags
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_organization-admin-invite:
      description: An invitation to become an organization administrator.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        author:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        created_at:
          description: The invite creation time.
          format: date-time
          type: string
        email:
          description: The invitee email address.
          format: email
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite-flags'
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        token:
          description: The invite token.
          type: string
        uuid:
          description: The unique identifier of the Invite.
          format: uuid
          type: string
      required:
      - uuid
      - email
      - created_at
      - token
      - flags
      - author
      - organization
      - _links
      type: object
    Acquia_Cloud_API_Documentation_organization-admin-invites:
      description: A collection of invitations to become an organization administrator.
      properties:
        _embedded:
          description: The collection of organization admin invites.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-invite'
              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_organization-admin-user-profile:
      description: An organization admin user profile.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        first_name:
          description: The user's first name.
          type: string
        flags:
          description: An array of flags for a user profile.
          properties:
            owner:
              description: Whether or not this user is the organization owner.
              type: boolean
          type: object
        last_login_at:
          deprecated: true
          description: The ISO-8601 formatted date/time of when the user last logged
            in.
          nullable: true
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        picture_url:
          description: The URI for the user's picture.
          format: uri
          nullable: true
          type: string
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          maxLength: 36
          minLength: 36
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - last_login_at
      - mail
      - picture_url
      - username
      - flags
      - _links
      type: object
    Acquia_Cloud_API_Documentation_organization-admin-user-profiles:
      description: A collection of organization administrator user profiles.
      properties:
        _embedded:
          description: The collection of organization admin user profiles.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profile'
              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_organization-applications:
      description: A collection of applications associated with an organization.
      properties:
        _embedded:
          description: A collection of applications.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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_organization-available-tags:
      description: A collection of organization members.
      properties:
        _embedded:
          description: A collection of tags associated with the organization.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag-organization'
              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_organization-members:
      description: A collection of organization members.
      properties:
        _embedded:
          description: A collection of organization member profiles.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-user-profile'
              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_organization-no-embedded:
      description: Organization information.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        admins_total:
          description: The number of administrators this organization has.
          type: integer
        flags:
          description: An array of various flags that indicate functionality for the
            organization.
          properties:
            federated_authentication:
              description: Indicates whether the organization supports federated authentication.
              type: boolean
          type: object
        id:
          description: The internal ID of the organization.
          type: string
        name:
          description: The name of the organization.
          type: string
        owner:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        roles_total:
          description: The number of roles this organization has.
          type: integer
        subscriptions_total:
          description: The number of subscriptions this organization has.
          type: integer
        teams_total:
          description: The number of teams this organization has.
          type: integer
        users_total:
          description: The number of users this organization has.
          type: integer
        uuid:
          description: The UUID of the organization.
          type: string
      required:
      - id
      - uuid
      - name
      - subscriptions_total
      - admins_total
      - users_total
      - teams_total
      - roles_total
      - owner
      - flags
      - _links
      type: object
    Acquia_Cloud_API_Documentation_organization-stub:
      properties:
        name:
          description: The human-readable organization name.
          type: string
        uuid:
          description: The organization's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - name
      type: object
    Acquia_Cloud_API_Documentation_organization-stub-embedded:
      description: A related organization.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        name:
          description: The human-readable organization name.
          type: string
        uuid:
          description: The organization's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - name
      type: object
    Acquia_Cloud_API_Documentation_organization-team-invite:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        applications:
          description: A array of applications this invite is granting access to.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
          type: array
        author:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        created_at:
          description: The invite creation time.
          format: date-time
          type: string
        email:
          description: The invitee email address.
          format: email
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite-flags'
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        roles:
          description: List of roles the invite will grant the invitee.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role-stub'
          type: array
        team:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-stub'
        token:
          description: The invite token.
          type: string
        uuid:
          description: The unique identifier of the Invite.
          format: uuid
          type: string
      required:
      - applications
      - author
      - organization
      - uuid
      - email
      - created_at
      - token
      - flags
      - team
      - roles
      - _links
      type: object
    Acquia_Cloud_API_Documentation_organization-team-invites:
      description: A collection of invitations to join a team.
      properties:
        _embedded:
          description: The collection of organization team invites.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-team-invite'
              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_organization-team-stub:
      description: A team within an organization.
      properties:
        name:
          description: The team name.
          type: string
        roles:
          description: An array of roles that the user has on this team.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role-stub'
          type: array
        uuid:
          description: The team unique identifier.
          format: uuid
          type: string
      required:
      - uuid
      - name
      - roles
      type: object
    Acquia_Cloud_API_Documentation_organization-user-profile:
      description: A user profile for an organization member.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        first_name:
          description: The user's first name.
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        picture_url:
          description: The URL for the user's picture.
          format: uri
          nullable: true
          type: string
        teams:
          description: A collection of teams this user has access to in an organization,
            and the roles they have on those teams.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-team-stub'
          type: array
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - mail
      - picture_url
      - username
      - teams
      - _links
      type: object
    Acquia_Cloud_API_Documentation_organizations:
      description: A collection of all organizations the current user has access to.
      properties:
        _embedded:
          description: A collection of organizations.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-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
      type: object
    Acquia_Cloud_API_Documentation_organizations-notifications:
      description: A collection of notifications matching the request parameters.
      properties:
        _embedded:
          description: A collection of notifications matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-stub'
              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_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_password:
      description: Describes the request body for a password.
      properties:
        password:
          description: The password to verify.
          type: string
      required:
      - password
      type: object
    Acquia_Cloud_API_Documentation_password-validation:
      description: The password validation response.
      properties:
        valid:
          description: Whether or not the password is valid.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_permission:
      properties:
        description:
          description: The description of the permission.
          nullable: true
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission-flags'
        group_label:
          description: The human readable label for the group.
          type: string
        label:
          description: The human readable label for the permission.
          type: string
        name:
          description: The name of the permission.
          type: string
      required:
      - name
      - label
      - description
      - group_label
      - flags
      type: object
    Acquia_Cloud_API_Documentation_permission-flags:
      description: An array of various flags regarding the status of the permission.
      properties:
        deprecated:
          description: Whether the permission is deprecated or not.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_permissions:
      description: A collection of all permissions that may be granted.
      properties:
        _embedded:
          description: A collection of permissions.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission'
              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_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_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_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_post-invite:
      properties:
        email:
          description: The email address of the user to invite to this team.
          format: email
          type: string
        roles:
          description: The role UUIDs to grant to the invitee.
          items:
            format: uuid
            type: string
          type: array
      required:
      - email
      - roles
      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_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_remote-administration:
      properties:
        copy_database:
          description: Whether to copy database from production to testing environment.
          type: boolean
        copy_files:
          description: Whether to copy files from production to testing environment.
          type: boolean
        deploy_at:
          description: What date/time to deploy RA updates at (if applicable).
          nullable: true
          type: string
        deploy_environment:
          description: The environment id of the environment to deploy to.
          type: string
        merge_branch:
          description: The development branch into which to merge the update tag.
          type: string
        merge_tag:
          description: Whether to automatically merge the approved code into your
            development branch.
          type: boolean
        pause_until:
          description: What date/time to pause RA updates until (if applicable).
          nullable: true
          type: string
        source_environment:
          description: The environment id of the environment to use as a starting
            point for testing.
          type: string
        update_mode:
          description: The update mode to select.
          enum:
          - update
          - inform
          - none
          type: string
        update_type:
          description: What components to update (core only or core and contrib modules).
          enum:
          - core
          - core_contrib
          type: string
      required:
      - update_mode
      type: object
    Acquia_Cloud_API_Documentation_remote-administration-settings:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        application_uuid:
          description: The application UUID.
          format: uuid
          type: string
        deploy_at:
          description: The ISO-8601 formatted date/time to deploy RA at. Only applicable
            for 'full' and 'inform' update modes and when it is in future.
          nullable: true
          type: string
        deploy_environment:
          description: The environment to deploy the code and production database
            to for testing.
          type: string
        flags:
          description: Remote administration settings flags.
          properties:
            copy_database:
              type: boolean
            copy_files:
              type: boolean
            merge_tag:
              type: boolean
          type: object
        merge_branch:
          description: The development branch into which the update tag will be merged.
          nullable: true
          type: string
        pause_until:
          description: The ISO-8601 formatted date/time to pause RA until. Only applicable
            for 'full' and 'inform' update modes and when it is in future.
          nullable: true
          type: string
        source_environment:
          description: The update source environment. Only applicable for 'full' mode.
          type: string
        update_mode:
          description: The remote administration update setting.
          enum:
          - full
          - inform
          - none
          type: string
        update_type:
          description: The remote administration update type (i.e. what to update).
          enum:
          - core
          - core_contrib
          type: string
      type: object
    Acquia_Cloud_API_Documentation_resource-tag:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        color:
          description: The color of the tag.
          type: string
        context:
          description: Metadata related to the tag.
          properties:
            application:
              description: A collection of application metadata for the tag.
              properties:
                uuids:
                  description: An array of application UUIDs.
                  items:
                    description: The application UUID.
                    format: uuid
                    type: string
                  type: array
              type: object
            organization:
              description: A collection of organization metadata for the tag.
              properties:
                uuids:
                  description: An array of organization UUIDs.
                  items:
                    description: The organization UUID.
                    format: uuid
                    type: string
                  type: array
              type: object
          type: object
        name:
          description: The name of the tag.
          type: string
      required:
      - name
      - color
      - context
      - _links
      type: object
    Acquia_Cloud_API_Documentation_resource-tag-embedded:
      description: An associated tag.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        color:
          description: The color of the tag.
          type: string
        name:
          description: The name of the tag.
          type: string
      required:
      - name
      - color
      - _links
      type: object
    Acquia_Cloud_API_Documentation_resource-tag-organization:
      properties:
        color:
          description: The color of the tag.
          type: string
        context:
          description: Metadata related to the tag.
          properties:
            application:
              description: A collection of application metadata for the tag.
              properties:
                uuids:
                  description: An array of application UUIDs.
                  items:
                    description: The application UUID.
                    format: uuid
                    type: string
                  type: array
              type: object
            organization:
              description: A collection of organization metadata for the tag.
              properties:
                uuids:
                  description: An array of organization UUIDs.
                  items:
                    description: The organization UUID.
                    format: uuid
                    type: string
                  type: array
              type: object
          type: object
        name:
          description: The name of the tag.
          type: string
      required:
      - name
      - color
      - context
      type: object
    Acquia_Cloud_API_Documentation_resource-tags:
      properties:
        _embedded:
          description: A collection of tags matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag'
              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_role:
      properties:
        description:
          description: A description of the role.
          type: string
        flags:
          description: Additional role status information.
          properties:
            default:
              description: True if this is a default role, false if it was user created.
              type: boolean
          type: object
        last_edited:
          description: When the role was last edited, and who edited it.
          properties:
            edited_at:
              description: The date the role was edited.
              format: date-time
              type: string
            user:
              $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
          type: object
        name:
          description: The role name.
          type: string
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        permissions:
          description: A collection of permissions a user with this role is granted.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission'
          type: array
        uuid:
          description: The role unique identifier.
          format: uuid
          type: string
      type: object
    Acquia_Cloud_API_Documentation_role-stub:
      properties:
        name:
          description: The role name.
          type: string
        uuid:
          description: The role unique identifier.
          format: uuid
          type: string
      required:
      - uuid
      - name
      type: object
    Acquia_Cloud_API_Documentation_roles:
      description: Collection of roles.
      properties:
        _embedded:
          description: A collection of roles.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role'
              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_root:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        status:
          description: The current status of various systems.
          properties:
            acf_provisioning_enabled:
              description: Whether Acquia Cloud Free provisioning is currently enabled.
              type: boolean
            acp_provisioning_enabled:
              description: Whether Acquia Cloud Professional provisioning is currently
                enabled.
              type: boolean
            configuration:
              description: The current configuration system status.
              type: boolean
            registry:
              description: The current registry system status.
              type: boolean
          type: object
      required:
      - status
      - _links
      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_security-settings:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        allowed_ips:
          description: A list of IPs and CIDR values allowed to access an application.
            Set to null to disable whitelisting.
          items:
            type: string
          type: array
        tfa_required:
          description: Whether TFA is required for an application.
          type: boolean
        uuid:
          description: The application UUID.
          format: uuid
          type: string
      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_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_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_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_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_settings:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
      type: object
    Acquia_Cloud_API_Documentation_shield-acl:
      description: Shield ACL rule.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        action:
          description: The action of the rule.
          enum:
          - allow
          - deny
          type: string
        addresses:
          description: The cidrs of the rule.
          items:
            description: The address in cidr or ipv4 format.
            format: cidr | ipv4
            type: string
          type: array
        description:
          description: The rule description.
          type: string
        service:
          description: The service associated with the rule.
          enum:
          - ssh
          type: string
        status:
          description: The status of the rule.
          enum:
          - active
          - inactive
          type: string
        subscription:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub'
        uuid:
          description: The unique identifier of the rule.
          format: uuid
          type: string
      required:
      - uuid
      - subscription
      - description
      - service
      - addresses
      - action
      - status
      - _links
      type: object
    Acquia_Cloud_API_Documentation_shield-acl-collection:
      description: Collection of Shield ACL rules.
      properties:
        _embedded:
          description: A collection of Shield ACL rules.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_shield-acl'
              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_ssh-key:
      description: Details an SSH key.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        created_at:
          description: The key creation date.
          format: date-time
          type: string
        fingerprint:
          description: The public key fingerprint.
          type: string
        label:
          description: The human-readable key label.
          type: string
        public_key:
          description: The public key.
          minLength: 64
          type: string
        uuid:
          description: The unique identifier of the SSH key.
          format: uuid
          type: string
      required:
      - uuid
      - label
      - public_key
      - fingerprint
      - created_at
      - _links
      type: object
    Acquia_Cloud_API_Documentation_ssh-key-request:
      description: Describes the request body for an SSH key.
      properties:
        label:
          description: The SSH key label.
          type: string
        public_key:
          description: The public key.
          type: string
      required:
      - label
      - public_key
      type: object
    Acquia_Cloud_API_Documentation_ssh-keys:
      description: A collection of SSH keys.
      properties:
        _embedded:
          description: A collection of SSH keys matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-key'
              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_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_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_subscription:
      description: 'A subscription is the product that allows for applications to
        be hosted with Acquia.

        In addition, a subscription grants access to various additional services.

        '
      properties:
        _embedded:
          description: A collection of resources related to the subscription.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
              type: array
          type: object
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        applications_total:
          description: The number of applications this subscription is entitled to.
          type: integer
        applications_used:
          description: The number of applications used.
          type: integer
        expire_at:
          description: The time when the service expires.
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-flags'
        id:
          description: The subscription ID.
          type: integer
        name:
          description: The subscription name.
          type: string
        organization:
          deprecated: true
          properties:
            name:
              description: The human-readable organization name.
              type: string
            uuid:
              description: The organization's UUID.
              format: uuid
              type: string
          required:
          - uuid
          - name
          type: object
        product:
          description: Defines the type of service this subscription is entitled to.
          properties:
            id:
              description: The product ID.
              type: integer
            name:
              description: The product name.
              type: string
            type:
              description: The product type.
              type: string
          type: object
        start_at:
          description: The time when the service defined by the subscription becomes
            available.
          type: string
        uuid:
          description: The subscription UUID.
          format: uuid
          type: string
      required:
      - id
      - uuid
      - name
      - start_at
      - expire_at
      - product
      - applications_total
      - applications_used
      - organization
      - flags
      - _links
      - _embedded
      type: object
    Acquia_Cloud_API_Documentation_subscription-applications:
      description: A collection of applications associated with a subscription.
      properties:
        _embedded:
          description: A collection of applications.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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_subscription-flags:
      description: An array of various flags that indicate functionality associated
        with subscription.
      properties:
        active:
          description: If the subscription is active.
          type: boolean
        expired:
          description: If the subscription is expired.
          type: boolean
        zuora:
          description: If the subscription is online paid.
          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_subscription-stub:
      description: The subscription this application belongs to.
      properties:
        name:
          description: The name of the subscription.
          type: string
        uuid:
          description: The UUID of the subscription.
          format: uuid
          type: string
      required:
      - uuid
      - name
      type: object
    Acquia_Cloud_API_Documentation_subscription-stub-embedded:
      description: A related subscription.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        name:
          description: The name of the subscription.
          type: string
        uuid:
          description: The UUID of the subscription.
          format: uuid
          type: string
      required:
      - uuid
      - name
      - _links
      type: object
    Acquia_Cloud_API_Documentation_subscription-usage-metric:
      description: Provides details about views and visits for a subscription.
      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_subscription-usage-metrics:
      description: A collection of usage metrics for a subscription.
      properties:
        _embedded:
          description: A collection of subscription metric items matching the request
            parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-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_subscriptions:
      description: Collection of subscriptions.
      properties:
        _embedded:
          description: A collection of subscriptions.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription'
              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_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_task:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        completed_at:
          description: The date that the task was completed.
          format: date-time
          type: string
        created_at:
          description: The date that this task was created.
          format: date-time
          type: string
        description:
          description: The description of the task.
          nullable: true
          type: string
        labels:
          description: Categorization labels associated with the task
          items:
            type: string
          type: array
        metadata:
          properties:
            author:
              description: The task author.
              properties:
                uuid:
                  description: The task author UUID.
                  format: uuid
                  type: string
              type: object
            created:
              description: When the task was created.
              type: integer
          type: object
        name:
          description: The machine name of the task.
          type: string
        progress:
          description: The progress of the event, from 0 to 100.
          maximum: 100
          minimum: 0
          type: integer
        reference_uuid:
          description: The UUID of the parent task. If there is no parent, this will
            be the task UUID.
          format: uuid
          type: string
        started_at:
          description: The date that the task was started.
          format: date-time
          type: string
        status:
          description: The status of the task.
          type: string
        title:
          description: The title of the task.
          type: string
        type:
          description: The type of task.
          type: string
        user:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
        uuid:
          description: The UUID of the task.
          format: uuid
          type: string
      required:
      - progress
      - user
      - uuid
      - name
      - title
      - description
      - created_at
      - started_at
      - status
      - type
      - metadata
      - labels
      - reference_uuid
      - _links
      type: object
    Acquia_Cloud_API_Documentation_team:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        created_at:
          description: The date the team was created.
          format: date-time
          type: string
        name:
          description: The name of the team.
          type: string
        organization:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
        updated_at:
          description: The date the team was last updated.
          format: date-time
          type: string
        uuid:
          description: The UUID of the team.
          format: uuid
          type: string
      required:
      - uuid
      - name
      - created_at
      - updated_at
      - organization
      - _links
      type: object
    Acquia_Cloud_API_Documentation_team-applications:
      description: A collection of applications associated with a team.
      properties:
        _embedded:
          description: A collection of applications.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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_team-invites:
      description: A collection of invites.
      properties:
        _embedded:
          description: A collection of invites matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite'
              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_team-members:
      description: A collection of team members.
      properties:
        _embedded:
          description: A collection of team member profiles.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-user-profile'
              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_team-stub:
      properties:
        name:
          description: The team name.
          type: string
        uuid:
          description: The team unique identifier.
          format: uuid
          type: string
      required:
      - uuid
      - name
      type: object
    Acquia_Cloud_API_Documentation_team-user-profile:
      description: A user profile for a team member.
      properties:
        first_name:
          description: The user's first name.
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        picture_url:
          description: The URI for the user's picture.
          format: uri
          type: string
        roles:
          description: A collection of roles this user has access to on a team.
          items:
            $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role-stub'
          type: array
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - mail
      - picture_url
      - username
      - roles
      type: object
    Acquia_Cloud_API_Documentation_teams:
      description: A collection of teams.
      properties:
        _embedded:
          description: A collection of teams matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team'
              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_token:
      description: Details a token.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        active:
          description: Whether or not this token is active.
          type: boolean
        created_at:
          description: The creation date and time.
          format: date-time
          type: string
        flags:
          description: Flags detailing the token's status.
          properties:
            active:
              description: Whether or not this token is active.
              type: boolean
          type: object
        label:
          description: The human-readable name for this token.
          type: string
        revocation:
          description: If set, the reason why this token was revoked.
          nullable: true
          type: string
        uuid:
          description: The token UUID.
          format: uuid
          type: string
      required:
      - uuid
      - active
      - label
      - revocation
      - flags
      - created_at
      - _links
      type: object
    Acquia_Cloud_API_Documentation_token-creation:
      description: Details about a created user access token.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        api_key:
          deprecated: true
          description: The API key.
          type: string
        api_secret:
          deprecated: true
          description: The API key secret.
          type: string
        client_id:
          description: The API client id.
          type: string
        client_secret:
          description: The API client secret.
          type: string
      required:
      - client_id
      - client_secret
      - _links
      type: object
    Acquia_Cloud_API_Documentation_token-request:
      description: Describes the request body for a token.
      properties:
        label:
          description: The label to give to the token for future reference.
          minLength: 1
          type: string
      required:
      - label
      type: object
    Acquia_Cloud_API_Documentation_tokens:
      description: A collection of tokens.
      properties:
        _embedded:
          description: A collection of tokens matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token'
              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_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_user:
      description: The response for a user object.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        company:
          description: The company of the user.
          type: string
        country:
          description: The country of the user.
          enum:
          - --
          - United States
          - Afghanistan
          - Albania
          - Algeria
          - American Samoa
          - Andorra
          - Angola
          - Anguilla
          - Antigua and Barbuda
          - Argentina
          - Armenia
          - Ascension Island
          - Australia
          - Austria
          - Azerbaijan
          - Bahamas
          - Bahrain
          - Bangladesh
          - Barbados
          - Belarus
          - Belgium
          - Belize
          - Benin
          - Bermuda
          - Bhutan
          - Bolivia
          - Bosnia and Herzegovina
          - Botswana
          - Brazil
          - British Indian Ocean Territory
          - Brunei Darussalam
          - Bulgaria
          - Burkina Faso
          - Burundi
          - Cambodia
          - Cameroon
          - Canada
          - Cape Verde
          - Cayman Islands
          - Central African Republic
          - Chad
          - Chile
          - China
          - Colombia
          - Comoros
          - Congo
          - Cook Islands
          - Costa Rica
          - Cote D Ivoire
          - Croatia
          - Cuba
          - Cyprus
          - Czech Republic
          - Denmark
          - Djibouti
          - Dominica
          - Dominican Republic
          - Ecuador
          - Egypt
          - El Salvador
          - Equatorial Guinea
          - Eritrea
          - Estonia
          - Ethiopia
          - Falkland Islands
          - Faroe Islands
          - Federated States of Micronesia
          - Fiji
          - Finland
          - France
          - French Guiana
          - French Polynesia
          - Gabon
          - Georgia
          - Germany
          - Ghana
          - Greece
          - Greenland
          - Grenada
          - Guadeloupe
          - Guatemala
          - Guam
          - Guinea
          - Guinea Bissau
          - Guyana
          - Haiti
          - Holy See (Vatican City)
          - Honduras
          - Hong Kong
          - Hungary
          - Iceland
          - India
          - Indonesia
          - Iran
          - Ireland
          - Isle of Man
          - Israel
          - Italy
          - Jamaica
          - Japan
          - Jordan
          - Kazakhstan
          - Kenya
          - Kiribati
          - Korea
          - Kuwait
          - Kyrgyzstan
          - Laos
          - Latvia
          - Lebanon
          - Lesotho
          - Liberia
          - Libya
          - Liechtenstein
          - Lithuania
          - Luxembourg
          - Macau
          - Macedonia
          - Madagascar
          - Malawi
          - Malaysia
          - Maldives
          - Mali
          - Malta
          - Marshall Islands
          - Martinique
          - Mauritius
          - Mayotte
          - Mexico
          - Moldova
          - Monaco
          - Mongolia
          - Montenegro
          - Montserrat
          - Morocco
          - Mozambique
          - Myanmar
          - Namibia
          - Nauru
          - Nepal
          - Netherlands
          - Netherlands Antilles
          - New Caledonia
          - New Zealand
          - Nicaragua
          - Niger
          - Nigeria
          - Niue
          - Norfolk Island
          - Northern Mariana Islands
          - Norway
          - Oman
          - Pakistan
          - Palau
          - Palestine
          - Panama
          - Papua New Guinea
          - Paraguay
          - Peru
          - Philippines
          - Pitcairn
          - Poland
          - Portugal
          - Puerto Rico
          - Qatar
          - Reunion
          - Romania
          - Russian Federation
          - Rwanda
          - Saint Vincent and the Grenadines
          - San Marino
          - Sao Tome and Principe
          - Saudi Arabia
          - Senegal
          - Serbia
          - Seychelles
          - Sierra Leone
          - Singapore
          - Slovakia
          - Slovenia
          - Solomon Islands
          - Somalia
          - South Africa
          - South Georgia
          - Spain
          - Sri Lanka
          - St. Kitts and Nevis
          - St. Lucia
          - St. Pierre and Miquelon
          - Sudan
          - Suriname
          - Swaziland
          - Sweden
          - Switzerland
          - Syrian Arab Republic
          - Taiwan
          - Tajikistan
          - Tanzania
          - Thailand
          - The Gambia
          - Togo
          - Tokelau
          - Tonga
          - Trinidad and Tobago
          - Tunisia
          - Turkey
          - Turkmenistan
          - Turks and Caicos Islands
          - Tuvalu
          - Uganda
          - Ukraine
          - United Arab Emirates
          - United Kingdom
          - Uruguay
          - Uzbekistan
          - Vanuatu
          - Venezuela
          - Viet Nam
          - Virgin Islands
          - Western Samoa
          - Yemen
          - Yugoslavia
          - Zaire
          - Zambia
          - Zimbabwe
          type: string
        created_at:
          description: The date/time when the user was created.
          format: date-time
          type: string
        features:
          deprecated: true
          description: The various feature flags for the user.
          items:
            enum:
            - ci-pipelines
            - n3-disabled
            - n3-hybrid-mode
            - on-demand-environments
            - php7
            - php71
            - platform
            type: string
          type: array
        first_name:
          description: The first name of the user.
          type: string
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-flags'
        id:
          deprecated: true
          description: The internal database ID (uid) of the user.
          type: integer
        job_function:
          description: The job function of the user.
          enum:
          - --
          - Business Executive
          - IT Executive
          - IT Architect or IT Operations
          - Product or Digital Marketing
          - Website Design or Development
          type: string
        job_title:
          description: The job title of the user.
          type: string
        last_login_at:
          description: The date/time of the last login for the user.
          format: date-time
          nullable: true
          type: string
        last_name:
          description: The last name of the user.
          type: string
        mail:
          description: The e-mail address of the user.
          format: email
          type: string
        metadata:
          deprecated: true
          description: Metadata related to the user.
          properties:
            applications:
              description: An array of application metadata for the user.
              properties:
                recent:
                  description: An array containing recent visited application information.
                  items:
                    properties:
                      recent_at:
                        description: The date-time when the application was accessed.
                        format: date-time
                        type: string
                      uuid:
                        description: The application UUID.
                        format: uuid
                        type: string
                    type: object
                  type: array
                starred:
                  description: An array containing starred application UUIDs.
                  items:
                    format: uuid
                    type: string
                  type: array
              type: object
          type: object
        name:
          description: The user name.
          type: string
        phone:
          description: The telephone numbers for the user.
          properties:
            office:
              description: The office telephone number for the user.
              nullable: true
              type: string
            tfa:
              description: The tfa backup telephone number for the user.
              nullable: true
              type: string
          type: object
        picture_url:
          description: The user's picture url.
          format: uri
          type: string
        state:
          description: The state of the user, if in the United States.
          enum:
          - Alabama
          - Alaska
          - American Samoa
          - Arizona
          - Arkansas
          - California
          - Colorado
          - Connecticut
          - Delaware
          - District of Columbia
          - Florida
          - Georgia
          - Hawaii
          - Idaho
          - Illinois
          - Indiana
          - Iowa
          - Kansas
          - Kentucky
          - Louisiana
          - Maine
          - Maryland
          - Massachusetts
          - Michigan
          - Minnesota
          - Mississippi
          - Missouri
          - Montana
          - Nebraska
          - Nevada
          - New Hampshire
          - New Jersey
          - New Mexico
          - New York
          - North Carolina
          - North Dakota
          - Northern Mariana Islands
          - Ohio
          - Oklahoma
          - Oregon
          - Pennsylvania
          - Rhode Island
          - South Carolina
          - South Dakota
          - Tennessee
          - Texas
          - U.S. Virgin Islands
          - Utah
          - Vermont
          - Virginia
          - Washington
          - West Virginia
          - Wisconsin
          - Wyoming
          type: string
        timezone:
          description: The timezone of the user.
          type: string
        uuid:
          description: The UUID for the user.
          format: uuid
          type: string
      required:
      - uuid
      - name
      - first_name
      - last_name
      - last_login_at
      - created_at
      - mail
      - phone
      - job_title
      - job_function
      - company
      - country
      - timezone
      - picture_url
      - flags
      - _links
      type: object
    Acquia_Cloud_API_Documentation_user-flags:
      description: The various flags for the user.
      properties:
        active:
          description: Whether or not this user is active.
          type: boolean
        support:
          description: Whether or not this user is a member of Acquia support.
          type: boolean
        tfa:
          description: Whether or not this user has TFA enabled.
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_user-profile:
      description: A user profile.
      properties:
        created_at:
          description: The date the user was created.
          format: date-time
          type: string
        email:
          description: The user's email address.
          format: email
          type: string
        first_name:
          description: The user's first name.
          type: string
        last_login_at:
          deprecated: true
          description: The date/time of the last login for the user.
          format: date-time
          nullable: true
          type: string
        last_name:
          description: The user's last name.
          type: string
        picture_url:
          description: The URL for the user's picture.
          format: uri
          nullable: true
          type: string
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - last_login_at
      - created_at
      - email
      - picture_url
      - username
      type: object
    Acquia_Cloud_API_Documentation_user-stub:
      properties:
        first_name:
          description: The user's first name.
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        picture_url:
          description: The URI for the user's picture.
          format: uri
          nullable: true
          type: string
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - mail
      - picture_url
      - username
      type: object
    Acquia_Cloud_API_Documentation_user-stub-embedded:
      description: A related user.
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        first_name:
          description: The user's first name.
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        picture_url:
          description: The URI for the user's picture.
          format: uri
          nullable: true
          type: string
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - mail
      - picture_url
      - username
      - _links
      type: object
    Acquia_Cloud_API_Documentation_user-stub-nullable:
      nullable: true
      properties:
        first_name:
          description: The user's first name.
          type: string
        last_name:
          description: The user's last name.
          type: string
        mail:
          description: The user's email address.
          format: email
          type: string
        picture_url:
          description: The URI for the user's picture.
          format: uri
          nullable: true
          type: string
        username:
          description: The user's internal user name.
          type: string
        uuid:
          description: The user's UUID.
          format: uuid
          type: string
      required:
      - uuid
      - first_name
      - last_name
      - mail
      - picture_url
      - username
      type: object
    Acquia_Cloud_API_Documentation_ux-message:
      properties:
        _links:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
        body:
          description: The message body.
          nullable: true
          type: string
        expire_at:
          description: The UTC timestamp of when the message expires.
          format: date-time
          type: string
        filters:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-filters'
        flags:
          $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-flags'
        id:
          description: The message identifier.
          type: integer
        start_at:
          description: The UTC timestamp of when the message started.
          format: date-time
          type: string
        title:
          description: The message title.
          type: string
        url:
          description: The message url.
          format: uri
          nullable: true
          type: string
        uuid:
          description: The message unique identifier.
          format: uuid
          type: string
        weight:
          description: The message priority weight.
          type: integer
      required:
      - id
      - uuid
      - title
      - body
      - url
      - filters
      - flags
      - weight
      - start_at
      - expire_at
      - _links
      type: object
    Acquia_Cloud_API_Documentation_ux-message-filters:
      description: Defines where a message should appear.
      properties:
        display_mode:
          description: How the message should be displayed.
          enum:
          - bar
          - list
          type: string
        paths:
          description: Collection of paths.
          items:
            description: Paths where a message should appear.
            type: string
          type: array
        type:
          description: The message type.
          enum:
          - alert
          - general
          - new
          - warning
          type: string
      type: object
    Acquia_Cloud_API_Documentation_ux-message-flags:
      description: An array of various flags associated with a message.
      properties:
        active:
          type: boolean
        dismissed:
          type: boolean
        dismissible:
          type: boolean
      type: object
    Acquia_Cloud_API_Documentation_ux-messages:
      properties:
        _embedded:
          description: A collection of application messages matching the request parameters.
          properties:
            items:
              items:
                $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message'
              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_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_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
    Codebase_Service_Application:
      deprecated: false
      description: Gets applications by codebase ID.
      properties:
        _links:
          items:
            type: string
          type: array
        id:
          $ref: '#/components/schemas/Codebase_Service_ApplicationId'
        machine_name:
          type: string
      type: object
    Codebase_Service_Application.jsonhal:
      deprecated: false
      description: Gets applications by codebase ID.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        id:
          $ref: '#/components/schemas/Codebase_Service_ApplicationId.jsonhal'
        machine_name:
          type: string
      type: object
    Codebase_Service_ApplicationId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_ApplicationId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_BulkCodeSwitch:
      deprecated: false
      description: Gets a Bulk Code Switch resource by its id and codebase.
      properties:
        _links:
          items:
            type: string
          type: array
        codebase_id:
          $ref: '#/components/schemas/Codebase_Service_CodebaseId'
        created_at:
          format: date-time
          type: string
        id:
          $ref: '#/components/schemas/Codebase_Service_BulkCodeSwitchId'
        reference:
          $ref: '#/components/schemas/Codebase_Service_ReferenceName'
      type: object
    Codebase_Service_BulkCodeSwitch.Message:
      deprecated: false
      description: ''
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/Codebase_Service_TranslatableMessage'
      type: object
    Codebase_Service_BulkCodeSwitch.Message.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/Codebase_Service_TranslatableMessage.jsonhal'
      type: object
    Codebase_Service_BulkCodeSwitch.jsonhal:
      deprecated: false
      description: Gets a Bulk Code Switch resource by its id and codebase.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        codebase_id:
          $ref: '#/components/schemas/Codebase_Service_CodebaseId.jsonhal'
        created_at:
          format: date-time
          type: string
        id:
          $ref: '#/components/schemas/Codebase_Service_BulkCodeSwitchId.jsonhal'
        reference:
          $ref: '#/components/schemas/Codebase_Service_ReferenceName.jsonhal'
      type: object
    Codebase_Service_BulkCodeSwitchId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_BulkCodeSwitchId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_BulkCodeSwitchTask:
      deprecated: false
      description: Gets status of tasks associated with bulk-code-switch id.
      properties:
        _links:
          items:
            type: string
          type: array
        completed_at:
          format: date-time
          nullable: true
          type: string
        created_at:
          format: date-time
          type: string
        logs:
          type: string
        name:
          type: string
        started_at:
          format: date-time
          nullable: true
          type: string
        status:
          type: string
        task_id:
          type: string
      type: object
    Codebase_Service_BulkCodeSwitchTask.jsonhal:
      deprecated: false
      description: Gets status of tasks associated with bulk-code-switch id.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        completed_at:
          format: date-time
          nullable: true
          type: string
        created_at:
          format: date-time
          type: string
        logs:
          type: string
        name:
          type: string
        started_at:
          format: date-time
          nullable: true
          type: string
        status:
          type: string
        task_id:
          type: string
      type: object
    Codebase_Service_Codebase:
      deprecated: false
      description: Gets a codebase by its ID
      properties:
        _links:
          items:
            type: string
          type: array
        applications_total:
          type: integer
        created_at:
          format: date-time
          type: string
        description:
          $ref: '#/components/schemas/Codebase_Service_Description'
        flags:
          additionalProperties:
            type: boolean
          type: object
        hash:
          $ref: '#/components/schemas/Codebase_Service_CodebaseHash'
        id:
          $ref: '#/components/schemas/Codebase_Service_CodebaseId'
        label:
          $ref: '#/components/schemas/Codebase_Service_Label'
        region:
          enum:
          - us-east-1
          - eu-west-1
          - us-west-2
          - ap-northeast-1
          - ap-southeast-1
          - ap-southeast-2
          - ca-central-1
          - eu-central-1
          type: string
        repository_id:
          $ref: '#/components/schemas/Codebase_Service_VcsRepositoryId'
        subscription:
          $ref: '#/components/schemas/Codebase_Service_Subscription'
        updated_at:
          format: date-time
          type: string
        vcs_url:
          $ref: '#/components/schemas/Codebase_Service_VcsUrl'
      type: object
    Codebase_Service_Codebase.Message:
      deprecated: false
      description: ''
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/Codebase_Service_TranslatableMessage'
      type: object
    Codebase_Service_Codebase.Message.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/Codebase_Service_TranslatableMessage.jsonhal'
      type: object
    Codebase_Service_Codebase.jsonhal:
      deprecated: false
      description: Gets a codebase by its ID
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        applications_total:
          type: integer
        created_at:
          format: date-time
          type: string
        description:
          $ref: '#/components/schemas/Codebase_Service_Description.jsonhal'
        flags:
          additionalProperties:
            type: boolean
          type: object
        hash:
          $ref: '#/components/schemas/Codebase_Service_CodebaseHash.jsonhal'
        id:
          $ref: '#/components/schemas/Codebase_Service_CodebaseId.jsonhal'
        label:
          $ref: '#/components/schemas/Codebase_Service_Label.jsonhal'
        region:
          enum:
          - us-east-1
          - eu-west-1
          - us-west-2
          - ap-northeast-1
          - ap-southeast-1
          - ap-southeast-2
          - ca-central-1
          - eu-central-1
          type: string
        repository_id:
          $ref: '#/components/schemas/Codebase_Service_VcsRepositoryId.jsonhal'
        subscription:
          $ref: '#/components/schemas/Codebase_Service_Subscription.jsonhal'
        updated_at:
          format: date-time
          type: string
        vcs_url:
          $ref: '#/components/schemas/Codebase_Service_VcsUrl.jsonhal'
      type: object
    Codebase_Service_CodebaseHash:
      deprecated: false
      description: ''
      properties:
        value:
          description: Constructor.
          type: string
      type: object
    Codebase_Service_CodebaseHash.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          description: Constructor.
          type: string
      type: object
    Codebase_Service_CodebaseId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_CodebaseId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_Description:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    Codebase_Service_Description.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    Codebase_Service_HealthCheck:
      deprecated: false
      description: Checks that the service is up.
      properties:
        _links:
          items:
            type: string
          type: array
        status:
          type: string
      type: object
    Codebase_Service_HealthCheck.jsonhal:
      deprecated: false
      description: Checks that the service is up.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        status:
          type: string
      type: object
    Codebase_Service_Label:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    Codebase_Service_Label.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    Codebase_Service_LocalId:
      deprecated: false
      description: ''
      properties:
        value:
          description: Constructor.
          type: string
      type: object
    Codebase_Service_LocalId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          description: Constructor.
          type: string
      type: object
    Codebase_Service_Reference:
      deprecated: false
      description: Retrieves a list of git references by codebase.
      properties:
        _links:
          items:
            type: string
          type: array
        codebase_id:
          $ref: '#/components/schemas/Codebase_Service_CodebaseId'
        id:
          $ref: '#/components/schemas/Codebase_Service_ReferenceId'
        name:
          $ref: '#/components/schemas/Codebase_Service_ReferenceName'
        type:
          enum:
          - BRANCH
          - TAG
          type: string
      type: object
    Codebase_Service_Reference.jsonhal:
      deprecated: false
      description: Retrieves a list of git references by codebase.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        codebase_id:
          $ref: '#/components/schemas/Codebase_Service_CodebaseId.jsonhal'
        id:
          $ref: '#/components/schemas/Codebase_Service_ReferenceId.jsonhal'
        name:
          $ref: '#/components/schemas/Codebase_Service_ReferenceName.jsonhal'
        type:
          enum:
          - BRANCH
          - TAG
          type: string
      type: object
    Codebase_Service_ReferenceId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_ReferenceId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_ReferenceName:
      deprecated: false
      description: ''
      properties:
        value:
          description: Constructor.
          type: string
      type: object
    Codebase_Service_ReferenceName.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          description: Constructor.
          type: string
      type: object
    Codebase_Service_Subscription:
      deprecated: false
      description: ''
      properties:
        _links:
          items:
            type: string
          type: array
        id:
          $ref: '#/components/schemas/Codebase_Service_SubscriptionId'
      type: object
    Codebase_Service_Subscription.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        id:
          $ref: '#/components/schemas/Codebase_Service_SubscriptionId.jsonhal'
      type: object
    Codebase_Service_SubscriptionId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_SubscriptionId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_TranslatableMessage:
      deprecated: false
      description: ''
      properties:
        domain:
          nullable: true
          type: string
        message:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    Codebase_Service_TranslatableMessage.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        domain:
          nullable: true
          type: string
        message:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    Codebase_Service_UriInterface:
      deprecated: false
      description: ''
      properties:
        authority:
          description: Retrieve the authority component of the URI.
          readOnly: true
          type: string
        fragment:
          description: Retrieve the fragment component of the URI.
          readOnly: true
          type: string
        host:
          description: Retrieve the host component of the URI.
          readOnly: true
          type: string
        path:
          description: Retrieve the path component of the URI.
          readOnly: true
          type: string
        port:
          description: Retrieve the port component of the URI.
          nullable: true
          readOnly: true
          type: integer
        query:
          description: Retrieve the query string of the URI.
          readOnly: true
          type: string
        scheme:
          description: Retrieve the scheme component of the URI.
          readOnly: true
          type: string
        userInfo:
          description: Retrieve the user information component of the URI.
          readOnly: true
          type: string
      type: object
    Codebase_Service_UriInterface.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        authority:
          description: Retrieve the authority component of the URI.
          readOnly: true
          type: string
        fragment:
          description: Retrieve the fragment component of the URI.
          readOnly: true
          type: string
        host:
          description: Retrieve the host component of the URI.
          readOnly: true
          type: string
        path:
          description: Retrieve the path component of the URI.
          readOnly: true
          type: string
        port:
          description: Retrieve the port component of the URI.
          nullable: true
          readOnly: true
          type: integer
        query:
          description: Retrieve the query string of the URI.
          readOnly: true
          type: string
        scheme:
          description: Retrieve the scheme component of the URI.
          readOnly: true
          type: string
        userInfo:
          description: Retrieve the user information component of the URI.
          readOnly: true
          type: string
      type: object
    Codebase_Service_VcsRepositoryId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_VcsRepositoryId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Codebase_Service_VcsUrl:
      deprecated: false
      description: ''
      properties:
        url:
          $ref: '#/components/schemas/Codebase_Service_UriInterface'
      type: object
    Codebase_Service_VcsUrl.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        url:
          $ref: '#/components/schemas/Codebase_Service_UriInterface.jsonhal'
      type: object
    MEO_Environment_Service_ApplicationId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_ApplicationId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_Cname:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    MEO_Environment_Service_Cname.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    MEO_Environment_Service_Codebase:
      deprecated: false
      description: ''
      properties:
        _links:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_CodebaseId'
      type: object
    MEO_Environment_Service_Codebase.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_CodebaseId.jsonhal'
      type: object
    MEO_Environment_Service_CodebaseId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_CodebaseId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_Database:
      deprecated: false
      description: Retrieve database info based on the site instance.
      properties:
        _links:
          items:
            type: string
          type: array
        database_host:
          type: string
        database_name:
          type: string
        database_password:
          type: string
        database_role:
          type: string
        database_user_name:
          type: string
      type: object
    MEO_Environment_Service_Database.Message:
      deprecated: false
      description: Create a new backup for the site instance Db.
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage'
      type: object
    MEO_Environment_Service_Database.Message.jsonhal:
      deprecated: false
      description: Create a new backup for the site instance Db.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage.jsonhal'
      type: object
    MEO_Environment_Service_Database.jsonhal:
      deprecated: false
      description: Retrieve database info based on the site instance.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        database_host:
          type: string
        database_name:
          type: string
        database_password:
          type: string
        database_role:
          type: string
        database_user_name:
          type: string
      type: object
    MEO_Environment_Service_DatabaseBackup:
      deprecated: false
      description: Retrieves details about a backup by its id associated with site(a
        site-instance).
      properties:
        _links:
          items:
            type: string
          type: array
        created_at:
          format: date-time
          type: string
        database_id:
          $ref: '#/components/schemas/MEO_Environment_Service_DatabaseId'
        environment:
          example: https://example.com/
          format: iri-reference
          type: string
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_DatabaseBackupId'
        site:
          example: https://example.com/
          format: iri-reference
          type: string
        type:
          enum:
          - DAILY
          - ON_DEMAND
          - INVALID
          type: string
      type: object
    MEO_Environment_Service_DatabaseBackup.Message:
      deprecated: false
      description: Restore a backup for the site instance Db.
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage'
      type: object
    MEO_Environment_Service_DatabaseBackup.Message.jsonhal:
      deprecated: false
      description: Restore a backup for the site instance Db.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage.jsonhal'
      type: object
    MEO_Environment_Service_DatabaseBackup.jsonhal:
      deprecated: false
      description: Retrieves details about a backup by its id associated with site(a
        site-instance).
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        created_at:
          format: date-time
          type: string
        database_id:
          $ref: '#/components/schemas/MEO_Environment_Service_DatabaseId.jsonhal'
        environment:
          example: https://example.com/
          format: iri-reference
          type: string
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_DatabaseBackupId.jsonhal'
        site:
          example: https://example.com/
          format: iri-reference
          type: string
        type:
          enum:
          - DAILY
          - ON_DEMAND
          - INVALID
          type: string
      type: object
    MEO_Environment_Service_DatabaseBackupId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_DatabaseBackupId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_DatabaseId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_DatabaseId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_Description:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    MEO_Environment_Service_Description.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    MEO_Environment_Service_Domain:
      deprecated: false
      description: Get a site instance domain.
      properties:
        _links:
          items:
            type: string
          type: array
        domain:
          $ref: '#/components/schemas/MEO_Environment_Service_DomainInfo'
        environment:
          example: https://example.com/
          format: iri-reference
          type: string
        name:
          readOnly: true
          type: string
        site:
          example: https://example.com/
          format: iri-reference
          type: string
      type: object
    MEO_Environment_Service_Domain.Message:
      deprecated: false
      description: Associate a site and environment with a domain.
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage'
      type: object
    MEO_Environment_Service_Domain.Message.jsonhal:
      deprecated: false
      description: Associate a site and environment with a domain.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage.jsonhal'
      type: object
    MEO_Environment_Service_Domain.jsonhal:
      deprecated: false
      description: Get a site instance domain.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        domain:
          $ref: '#/components/schemas/MEO_Environment_Service_DomainInfo.jsonhal'
        environment:
          example: https://example.com/
          format: iri-reference
          type: string
        name:
          readOnly: true
          type: string
        site:
          example: https://example.com/
          format: iri-reference
          type: string
      type: object
    MEO_Environment_Service_DomainInfo:
      deprecated: false
      description: ''
      properties:
        is_managed:
          type: boolean
        name:
          $ref: '#/components/schemas/MEO_Environment_Service_DomainName'
      type: object
    MEO_Environment_Service_DomainInfo.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        is_managed:
          type: boolean
        name:
          $ref: '#/components/schemas/MEO_Environment_Service_DomainName.jsonhal'
      type: object
    MEO_Environment_Service_DomainName:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    MEO_Environment_Service_DomainName.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    MEO_Environment_Service_DomainStatus:
      deprecated: false
      description: Get a site instance domain status.
      properties:
        _links:
          items:
            type: string
          type: array
        cnames:
          items:
            $ref: '#/components/schemas/MEO_Environment_Service_Cname'
          type: array
        environment_id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId'
        flags:
          $ref: '#/components/schemas/MEO_Environment_Service_Flags'
        hostname:
          $ref: '#/components/schemas/MEO_Environment_Service_DomainName'
        ip_addresses:
          items:
            $ref: '#/components/schemas/MEO_Environment_Service_IpAddress'
          type: array
        site_id:
          $ref: '#/components/schemas/MEO_Environment_Service_SiteId'
      type: object
    MEO_Environment_Service_DomainStatus.jsonhal:
      deprecated: false
      description: Get a site instance domain status.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        cnames:
          items:
            $ref: '#/components/schemas/MEO_Environment_Service_Cname.jsonhal'
          type: array
        environment_id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId.jsonhal'
        flags:
          $ref: '#/components/schemas/MEO_Environment_Service_Flags.jsonhal'
        hostname:
          $ref: '#/components/schemas/MEO_Environment_Service_DomainName.jsonhal'
        ip_addresses:
          items:
            $ref: '#/components/schemas/MEO_Environment_Service_IpAddress.jsonhal'
          type: array
        site_id:
          $ref: '#/components/schemas/MEO_Environment_Service_SiteId.jsonhal'
      type: object
    MEO_Environment_Service_Environment:
      deprecated: false
      description: Lists all environments for a codebase.
      properties:
        _links:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
        application_id:
          $ref: '#/components/schemas/MEO_Environment_Service_ApplicationId'
        code_switch_status:
          enum:
          - IDLE
          - IN_PROGRESS
          type: string
        codebase:
          $ref: '#/components/schemas/MEO_Environment_Service_Codebase'
        description:
          $ref: '#/components/schemas/MEO_Environment_Service_Description'
        flags:
          additionalProperties:
            type: boolean
          type: object
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId'
        label:
          $ref: '#/components/schemas/MEO_Environment_Service_Label'
        name:
          $ref: '#/components/schemas/MEO_Environment_Service_MachineName'
        properties:
          additionalProperties:
            type: integer
          type: object
        reference:
          type: string
        ssh_url:
          type: string
        status:
          enum:
          - normal
          - allocated
          - launching
          - killed
          - cancelled
          - stopped
          type: string
      type: object
    MEO_Environment_Service_Environment.Message:
      deprecated: false
      description: Updates an environment by ID.
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage'
      type: object
    MEO_Environment_Service_Environment.Message.jsonhal:
      deprecated: false
      description: Updates an environment by ID.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage.jsonhal'
      type: object
    MEO_Environment_Service_Environment.jsonhal:
      deprecated: false
      description: Lists all environments for a codebase.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        application_id:
          $ref: '#/components/schemas/MEO_Environment_Service_ApplicationId.jsonhal'
        code_switch_status:
          enum:
          - IDLE
          - IN_PROGRESS
          type: string
        codebase:
          $ref: '#/components/schemas/MEO_Environment_Service_Codebase.jsonhal'
        description:
          $ref: '#/components/schemas/MEO_Environment_Service_Description.jsonhal'
        flags:
          additionalProperties:
            type: boolean
          type: object
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId.jsonhal'
        label:
          $ref: '#/components/schemas/MEO_Environment_Service_Label.jsonhal'
        name:
          $ref: '#/components/schemas/MEO_Environment_Service_MachineName.jsonhal'
        properties:
          additionalProperties:
            type: integer
          type: object
        reference:
          type: string
        ssh_url:
          type: string
        status:
          enum:
          - normal
          - allocated
          - launching
          - killed
          - cancelled
          - stopped
          type: string
      type: object
    MEO_Environment_Service_EnvironmentId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_EnvironmentId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_Flags:
      deprecated: false
      description: ''
      properties:
        flags:
          additionalProperties:
            type: boolean
          type: object
      type: object
    MEO_Environment_Service_Flags.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        flags:
          additionalProperties:
            type: boolean
          type: object
      type: object
    MEO_Environment_Service_HealthStatus:
      deprecated: false
      description: ''
      properties:
        code:
          type: string
        details:
          type: string
        summary:
          type: string
      type: object
    MEO_Environment_Service_HealthStatus.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        code:
          type: string
        details:
          type: string
        summary:
          type: string
      type: object
    MEO_Environment_Service_IpAddress:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    MEO_Environment_Service_IpAddress.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    MEO_Environment_Service_Label:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    MEO_Environment_Service_Label.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    MEO_Environment_Service_LocalId:
      deprecated: false
      description: ''
      properties:
        value:
          description: Constructor.
          type: string
      type: object
    MEO_Environment_Service_LocalId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          description: Constructor.
          type: string
      type: object
    MEO_Environment_Service_MachineName:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    MEO_Environment_Service_MachineName.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    MEO_Environment_Service_PrivateNetworkId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_PrivateNetworkId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_PrivateNetworkReference:
      deprecated: false
      description: Get the private network associated with an environment
      properties:
        _links:
          items:
            type: string
          type: array
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_PrivateNetworkId'
        label:
          $ref: '#/components/schemas/MEO_Environment_Service_Label'
      type: object
    MEO_Environment_Service_PrivateNetworkReference.jsonhal:
      deprecated: false
      description: Get the private network associated with an environment
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        id:
          $ref: '#/components/schemas/MEO_Environment_Service_PrivateNetworkId.jsonhal'
        label:
          $ref: '#/components/schemas/MEO_Environment_Service_Label.jsonhal'
      type: object
    MEO_Environment_Service_SiteId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_SiteId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    MEO_Environment_Service_SiteInstance:
      deprecated: false
      description: Retrieve details about an environment association with a site (a
        site instance).
      properties:
        _links:
          items:
            type: string
          type: array
        domains:
          items:
            $ref: '#/components/schemas/MEO_Environment_Service_DomainInfo'
          type: array
        environment_id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId'
        health_status:
          $ref: '#/components/schemas/MEO_Environment_Service_HealthStatus'
        site_id:
          $ref: '#/components/schemas/MEO_Environment_Service_SiteId'
        status:
          enum:
          - SITE_INSTANCE_STATUS_UNSPECIFIED
          - SITE_INSTANCE_STATUS_PENDING
          - SITE_INSTANCE_STATUS_READY
          - SITE_INSTANCE_STATUS_FAILED
          - SITE_INSTANCE_STATUS_MARKED_FOR_DELETION
          - SITE_INSTANCE_STATUS_DELETING
          - SITE_INSTANCE_STATUS_DELETED
          - SITE_INSTANCE_STATUS_DELETE_FAILED
          - SITE_INSTANCE_STATUS_SYNCING
          - SITE_INSTANCE_STATUS_FINALIZING
          - SITE_INSTANCE_STATUS_DISABLED
          type: string
      type: object
    MEO_Environment_Service_SiteInstance.Message:
      deprecated: false
      description: Dissociate a site and environment with no grace period.
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage'
      type: object
    MEO_Environment_Service_SiteInstance.Message.jsonhal:
      deprecated: false
      description: Dissociate a site and environment with no grace period.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage.jsonhal'
      type: object
    MEO_Environment_Service_SiteInstance.jsonhal:
      deprecated: false
      description: Retrieve details about an environment association with a site (a
        site instance).
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        domains:
          items:
            $ref: '#/components/schemas/MEO_Environment_Service_DomainInfo.jsonhal'
          type: array
        environment_id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId.jsonhal'
        health_status:
          $ref: '#/components/schemas/MEO_Environment_Service_HealthStatus.jsonhal'
        site_id:
          $ref: '#/components/schemas/MEO_Environment_Service_SiteId.jsonhal'
        status:
          enum:
          - SITE_INSTANCE_STATUS_UNSPECIFIED
          - SITE_INSTANCE_STATUS_PENDING
          - SITE_INSTANCE_STATUS_READY
          - SITE_INSTANCE_STATUS_FAILED
          - SITE_INSTANCE_STATUS_MARKED_FOR_DELETION
          - SITE_INSTANCE_STATUS_DELETING
          - SITE_INSTANCE_STATUS_DELETED
          - SITE_INSTANCE_STATUS_DELETE_FAILED
          - SITE_INSTANCE_STATUS_SYNCING
          - SITE_INSTANCE_STATUS_FINALIZING
          - SITE_INSTANCE_STATUS_DISABLED
          type: string
      type: object
    MEO_Environment_Service_TranslatableMessage:
      deprecated: false
      description: ''
      properties:
        domain:
          type: string
        message:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    MEO_Environment_Service_TranslatableMessage.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        domain:
          type: string
        message:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    MEO_Environment_Service_TrustedProxies:
      deprecated: false
      description: Retrieves trusted proxy configuration for an environment.
      properties:
        _links:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
        associated_cdns:
          items:
            type: string
          type: array
        cidrs_ipv4:
          items:
            type: string
          type: array
        cidrs_ipv6:
          items:
            type: string
          type: array
        environment_id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId'
      type: object
    MEO_Environment_Service_TrustedProxies.Message:
      deprecated: false
      description: Updates trusted proxy configuration for an environment.
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage'
      type: object
    MEO_Environment_Service_TrustedProxies.Message.jsonhal:
      deprecated: false
      description: Updates trusted proxy configuration for an environment.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/MEO_Environment_Service_TranslatableMessage.jsonhal'
      type: object
    MEO_Environment_Service_TrustedProxies.jsonhal:
      deprecated: false
      description: Retrieves trusted proxy configuration for an environment.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        associated_cdns:
          items:
            type: string
          type: array
        cidrs_ipv4:
          items:
            type: string
          type: array
        cidrs_ipv6:
          items:
            type: string
          type: array
        environment_id:
          $ref: '#/components/schemas/MEO_Environment_Service_EnvironmentId.jsonhal'
      type: object
    Private_Network_Service_API_Connections:
      properties:
        cidr:
          pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
          type: string
        private_egress_access:
          $ref: '#/components/schemas/Private_Network_Service_API_PrivateEgressAccess'
        vpc_peers:
          items:
            $ref: '#/components/schemas/Private_Network_Service_API_VPCPeers'
          type: array
        vpns:
          items:
            $ref: '#/components/schemas/Private_Network_Service_API_VPN'
          type: array
      required:
      - cidr
      type: object
    Private_Network_Service_API_ConnectionsResponse:
      description: Connections block of a private network
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
        cidr:
          pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
          type: string
        private_egress_access:
          $ref: '#/components/schemas/Private_Network_Service_API_PrivateEgressAccess'
      required:
      - cidr
      type: object
    Private_Network_Service_API_DrupalSSH:
      properties:
        id:
          type: integer
        ingress_acls:
          items:
            type: string
          type: array
        private:
          default: false
          type: boolean
      type: object
    Private_Network_Service_API_EmbeddedPrivateNetworkList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Private_Network_Service_API_PrivateNetworkResponse'
          type: array
      type: object
    Private_Network_Service_API_EmbeddedVPCPeerList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Private_Network_Service_API_VPCPeersResponse'
          type: array
      type: object
    Private_Network_Service_API_EmbeddedVPNList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Private_Network_Service_API_VPNResponse'
          type: array
      type: object
    Private_Network_Service_API_Error:
      properties:
        error:
          type: string
        message:
          type: string
      required:
      - message
      - error
      type: object
    Private_Network_Service_API_HalItem:
      properties:
        parent:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
        self:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
      required:
      - self
      type: object
    Private_Network_Service_API_HalLink:
      description: HAL link object
      properties:
        href:
          description: The target URI of the link (can be a URI or URI template)
          type: string
      required:
      - href
      type: object
    Private_Network_Service_API_Ingress:
      properties:
        drupal_ssh:
          $ref: '#/components/schemas/Private_Network_Service_API_DrupalSSH'
      type: object
    Private_Network_Service_API_IngressResponse:
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
        drupal_ssh:
          $ref: '#/components/schemas/Private_Network_Service_API_DrupalSSH'
      type: object
    Private_Network_Service_API_Isolation:
      properties:
        dedicated_compute:
          type: boolean
        dedicated_network:
          type: boolean
      type: object
    Private_Network_Service_API_IsolationResponse:
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
        dedicated_compute:
          type: boolean
        dedicated_network:
          type: boolean
      type: object
    Private_Network_Service_API_LinkType:
      properties:
        href:
          type: string
      required:
      - href
      type: object
    Private_Network_Service_API_Message:
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
        message:
          description: Message describing the operation result
          type: string
      required:
      - message
      type: object
    Private_Network_Service_API_PrivateEgressAccess:
      properties:
        drupal:
          type: boolean
      type: object
    Private_Network_Service_API_PrivateNetworkHALLinks:
      properties:
        connections:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
        ingress:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
        isolation:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
        self:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
        vpc_peers:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
        vpns:
          $ref: '#/components/schemas/Private_Network_Service_API_HalLink'
      required:
      - self
    Private_Network_Service_API_PrivateNetworkResponse:
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_PrivateNetworkHALLinks'
        created_at:
          description: Timestamp when the private network was created
          format: date-time
          type: string
        description:
          description: A brief description of the private network
          type: string
        id:
          type: string
        label:
          description: A label for the private network
          type: string
        name:
          description: The name of the private network
          type: string
        region:
          description: The region where the private network is deployed
          type: string
        status:
          description: The current status of the private network
          enum:
          - creating
          - active
          - create-failed
          - updating
          - update-failed
          - deleting
          - deleted
          - delete-failed
          type: string
        subscription_id:
          type: string
        updated_at:
          description: Timestamp when the private network was last updated
          format: date-time
          type: string
      type: object
    Private_Network_Service_API_Tunnel:
      properties:
        dpd_timeout_action:
          type: string
        id:
          type: integer
        ike_versions:
          type: string
        internal_cidr:
          pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
          type: string
        shared_key:
          type: string
        startup_action:
          type: string
      type: object
    Private_Network_Service_API_TunnelResponse:
      properties:
        address:
          format: ipv4
          type: string
        dpd_timeout_action:
          type: string
        id:
          type: integer
        ike_versions:
          type: string
        internal_cidr:
          pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
          type: string
        shared_key:
          type: string
        startup_action:
          type: string
      type: object
    Private_Network_Service_API_UpdateConnectionRequestSpec:
      properties:
        private_egress_access:
          $ref: '#/components/schemas/Private_Network_Service_API_PrivateEgressAccess'
      type: object
    Private_Network_Service_API_UpdatePrivateNetworkRequestSpec:
      properties:
        description:
          type: string
        label:
          type: string
      type: object
    Private_Network_Service_API_VPCPeers:
      properties:
        aws_account:
          type: string
        id:
          type: integer
        name:
          type: string
        vpc_cidr:
          pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
          type: string
        vpc_id:
          type: string
      type: object
    Private_Network_Service_API_VPCPeersResponse:
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
        aws_account:
          type: string
        id:
          type: integer
        name:
          type: string
        peering_connection_id:
          description: The ID of the peering connection (optional)
          type: string
        vpc_cidr:
          pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
          type: string
        vpc_id:
          type: string
      type: object
    Private_Network_Service_API_VPN:
      properties:
        gateway_ip:
          format: ipv4
          type: string
        id:
          type: integer
        name:
          type: string
        routes:
          items:
            pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
            type: string
          type: array
        tunnel1:
          $ref: '#/components/schemas/Private_Network_Service_API_Tunnel'
        tunnel2:
          $ref: '#/components/schemas/Private_Network_Service_API_Tunnel'
      required:
      - name
      - gateway_ip
      - routes
      type: object
    Private_Network_Service_API_VPNResponse:
      properties:
        _links:
          $ref: '#/components/schemas/Private_Network_Service_API_HalItem'
        gateway_ip:
          format: ipv4
          type: string
        id:
          type: integer
        name:
          type: string
        routes:
          items:
            pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$
            type: string
          type: array
        tunnel1:
          $ref: '#/components/schemas/Private_Network_Service_API_TunnelResponse'
        tunnel2:
          $ref: '#/components/schemas/Private_Network_Service_API_TunnelResponse'
      required:
      - name
      - gateway_ip
      - routes
      type: object
    Private_Network_Service_API_ValidationError:
      properties:
        error:
          type: string
        message:
          additionalProperties:
            type: string
          example:
            another_field: Invalid value provided
            fieldName: This field is required
          type: object
      required:
      - error
      - message
      type: object
    Site_Service_CodebaseId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Site_Service_CodebaseId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Site_Service_Label:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    Site_Service_Label.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    Site_Service_LocalId:
      deprecated: false
      description: ''
      properties:
        value:
          description: Constructor.
          type: string
      type: object
    Site_Service_LocalId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          description: Constructor.
          type: string
      type: object
    Site_Service_Site:
      deprecated: false
      description: Get a list of sites accessible by the user.
      properties:
        _links:
          items:
            type: string
          type: array
        codebase_id:
          $ref: '#/components/schemas/Site_Service_CodebaseId'
        description:
          $ref: '#/components/schemas/Site_Service_SiteDescription'
        id:
          $ref: '#/components/schemas/Site_Service_SiteId'
        label:
          $ref: '#/components/schemas/Site_Service_Label'
        name:
          $ref: '#/components/schemas/Site_Service_SiteName'
      type: object
    Site_Service_Site.Message:
      deprecated: false
      description: Update a site details
      properties:
        _links:
          items:
            type: string
          type: array
        message:
          $ref: '#/components/schemas/Site_Service_TranslatableMessage'
      type: object
    Site_Service_Site.Message.jsonhal:
      deprecated: false
      description: Update a site details
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        message:
          $ref: '#/components/schemas/Site_Service_TranslatableMessage.jsonhal'
      type: object
    Site_Service_Site.jsonhal:
      deprecated: false
      description: Get a list of sites accessible by the user.
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        codebase_id:
          $ref: '#/components/schemas/Site_Service_CodebaseId.jsonhal'
        description:
          $ref: '#/components/schemas/Site_Service_SiteDescription.jsonhal'
        id:
          $ref: '#/components/schemas/Site_Service_SiteId.jsonhal'
        label:
          $ref: '#/components/schemas/Site_Service_Label.jsonhal'
        name:
          $ref: '#/components/schemas/Site_Service_SiteName.jsonhal'
      type: object
    Site_Service_SiteDescription:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    Site_Service_SiteDescription.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    Site_Service_SiteId:
      deprecated: false
      description: ''
      properties:
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Site_Service_SiteId.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        attribute:
          description: Retrieves the resource ID's metadata.
          readOnly: true
        local_id:
          readOnly: true
        prefix:
          readOnly: true
        urn:
          readOnly: true
          type: string
        value:
          type: string
      type: object
    Site_Service_SiteName:
      deprecated: false
      description: ''
      properties:
        value:
          type: string
      type: object
    Site_Service_SiteName.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        value:
          type: string
      type: object
    Site_Service_TranslatableMessage:
      deprecated: false
      description: ''
      properties:
        domain:
          type: string
        message:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    Site_Service_TranslatableMessage.jsonhal:
      deprecated: false
      description: ''
      properties:
        _links:
          properties:
            self:
              properties:
                href:
                  format: iri-reference
                  type: string
              type: object
          type: object
        domain:
          type: string
        message:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
  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
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 - Environments
  version: 2.0.0
  x-logo:
    altText: Acquia Cloud
    backgroundColor: '#FFFFFF'
    url: assets/cloud-platform.svg
openapi: 3.0.0
paths:
  /environments/{environmentId}:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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}:
    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:
    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:
    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:
    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}:
    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:
    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}:
    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:
    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:
    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:
    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:
    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:
    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:
    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}:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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}:
    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:
    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:
    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:
    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}:
    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:
    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:
    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:
    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:
    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:
    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:
    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}:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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}:
    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:
    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}:
    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:
    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:
    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:
    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:
    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:
    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:
    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:
    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}:
    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:
    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:
    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:
    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}:
    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:
    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}:
    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
servers: []
tags:
- name: Environments