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_\-*]+|[>https://docs.acquia.com/acquia-cloud/develop/api/auth/\n\
\n### Example implementation\n\nAn example PHP script for making authenticated\
\ API requests can be found here. This script uses the League/oauth2-client library, installed via Composer.\n"
title: Acquia Cloud API - Applications
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
openapi: 3.0.0
paths:
/applications:
get:
description: 'Applications contains the code, files, and databases required
to run sites. You have access to an application if you are a member of a team
that has access to an application, or if you are an administrator or owner
of the organization that the application belongs to. A subscription may contain
one or more applications.
Filterable fields:
* `label`
* `name` (Deprecated)
* `organization_name`
* `hosting` (Deprecated) Use URL encoded colon (%3A) to separate realm
and sitegroup, e.g. network%3An3 instead of network:n3
Sortable fields:
* `label`
* `name` (Deprecated)
* `organization_name`
'
operationId: getApplications
parameters:
- $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/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 241643
name: Sample application 1
organization:
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
status: normal
subscription:
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471
flags:
remote_admin: false
hosting:
id: devcloud:devcloud2
type: free
id: 954291
name: Sample application 2
organization:
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
status: provisioning
subscription:
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: node
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
_links:
filter:
href: https://cloud.acquia.com/api/applications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/
self:
href: https://cloud.acquia.com/api/applications?limit=10
sort:
href: https://cloud.acquia.com/api/applications{?sort}
templated: true
pagination:
limit: 10
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications'
description: OK
'403':
content:
application/hal+json:
examples:
Not found:
value:
error: forbidden
message: You do not have permission to view applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return a List of Applications the Current User Has Access To.
tags:
- Applications
x-cli-name: applications:list
/applications/{applicationUuid}:
get:
description: A specific application.
operationId: getApplicationByUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
organization:
_links:
self:
href: https://cloud.acquia.com/api/organizations/6a907396-abfd-4d01-9da6-64c8efc04519
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
subscription:
_links:
self:
href: https://cloud.acquia.com/api/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d470
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
_links:
code:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/code
databases:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases
environments:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/environments
events:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/events
features:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/features
ides:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/ides
parent:
href: https://cloud.acquia.com/api/applications
permissions:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/permissions
search:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/search
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
settings:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings
tasks:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks
teams:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/teams
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 2416431
name: Sample application
organization:
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
status: normal
subscription:
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application'
description: OK
'404':
content:
application/hal+json:
example:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Details About a Specific Application.
tags:
- Applications
x-cli-name: applications:find
put:
description: Renames a specific application.
operationId: putApplicationByUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
name: My new application name
schema:
properties:
name:
description: The new name of the application.
maxLength: 255
minLength: 1
type: string
type: object
application/x-www-form-urlencoded:
example:
name: My new application name
schema:
properties:
name:
description: The new name of the application.
type: string
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/27698331-bcf9-48e9-9f12-931ac88f446f
parent:
href: https://cloud.acquia.com/api/applications
self:
href: https://cloud.acquia.com/api/applications/db1d0e46-6799-4208-9786-c7e64150a7c7
message: Application renamed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'400':
content:
application/hal+json:
examples:
Name already in use:
value:
error: validation_failed
message:
name: You already have an application with this name.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to modify this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application:
value:
error: not_found
message: The application with UUID a47ac10b-58cc-4372-a567-0e02b2c3d470
does not exist.
No application or permission:
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:
Name in use:
value:
error: conflict
message: The new application name is the same as the old application
name. No action taken.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Renames an Application.
tags:
- Applications
x-cli-name: applications:rename
/applications/{applicationUuid}/artifacts:
get:
description: 'Returns a list of this application''s build artifacts. Only available
for Node.js applications.
Filterable fields:
* `created`
* `name`
Sortable fields:
* `created`
* `name`
'
operationId: getArtifactsByApplicationUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1
created_at: '2012-05-15T12:00:00Z'
id: 1
name: master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2
state: ready
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/2
created_at: '2012-05-15T12:00:00Z'
id: 2
name: master@a265389db6a6918cf4e51edbe5f06d7e1578175c
state: pending-upload
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/3
created_at: '2012-05-15T12:00:00Z'
id: 3
name: master@e7157f36e5fb82317ffee2fc2d70302cdad0c60c
state: deleted
_links:
filter:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts
sort:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifacts'
description: OK
'404':
content:
application/hal+json:
examples:
Application type:
value:
error: not_found
message: Artifacts are only available for Node.js applications.
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Application Artifacts.
tags:
- Applications
x-cli-name: applications:artifact-list
/applications/{applicationUuid}/artifacts/{artifactId}:
get:
description: 'A specific artifact.
'
operationId: getArtifactByApplicationUuidAndId
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_artifact-id'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1
created_at: '2012-05-15T12:00:00Z'
id: 1
name: master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2
state: ready
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact'
description: OK
'404':
content:
application/hal+json:
examples:
Application type:
value:
error: not_found
message: Artifacts are only available for Node.js applications.
No application:
value:
error: not_found
message: The application with UUID a47ac10b-58cc-4372-a567-0e02b2c3d470
does not exist.
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist,
or you do not have permission to access it.
No artifact:
value:
error: not_found
message: The build artifact 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 Artifact.
tags:
- Applications
x-cli-name: applications:artifact-find
/applications/{applicationUuid}/code:
get:
description: 'Returns a list of branches and release (repository) tags in this
application''s version control system.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getCodeByApplicationUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- flags:
tag: false
name: master
- flags:
tag: false
name: feature-branch
- flags:
tag: true
name: tags/2014-09-03
- flags:
tag: true
name: tags/2014-09-03.0
_links:
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/code
total: 4
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code'
description: OK
'404':
content:
application/hal+json:
examples:
No VCS Settings:
value:
error: not_found
message: No version control system settings found on non-hosted
application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Application Branches and Release Tags.
tags:
- Applications
x-cli-name: applications:vcs-info
/applications/{applicationUuid}/code-studio:
delete:
description: Removes the Code Studio project from an application.
operationId: deleteCodeStudioProject
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/e0c0ec4d-cb4d-4b9a-92ed-503d1e8dae4a
self:
href: https://cloud.acquia.com/api/applications/98529a07-5f07-4c4d-836b-03c9226c03fd/code-studio
message: The Code Studio project is being removed from the Application.
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 remove the Code Studio
project from this Application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes the Code Studio Project from an Application.
tags:
- Applications
get:
description: Return details about the Code Studio project for an application.
operationId: getCodeStudioProject
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
application:
_links:
self:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c
name: My Application
uuid: 906c1ad5-f367-4127-b529-9dbe29bc5c1c
_links:
application:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c
applications:
href: https://cloud.acquia.com/api/applications
code-studio:
href: https://code.acquia.com/path/to/project
code-studio-api:
href: https://code.acquia.com/api/v4/path/to/project
parent:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c
self:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c/code-studio
application_id: 906c1ad5-f367-4127-b529-9dbe29bc5c1c
status: active
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-project'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Code Studio not enabled for application:
value:
error: not_found
message: Code Studio is not enabled for this application.
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Details About the Code Studio Project for an Application.
tags:
- Applications
post:
description: Creates the Code Studio project for an application.
operationId: postCodeStudioProject
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/e0c0ec4d-cb4d-4b9a-92ed-503d1e8dae4a
self:
href: https://cloud.acquia.com/api/applications/98529a07-5f07-4c4d-836b-03c9226c03fd/code-studio
message: A Code Studio project is being created for the Application.
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 create a Code Studio project
for this Application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates the Code Studio Project for an Application.
tags:
- Applications
/applications/{applicationUuid}/databases:
get:
description: 'Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getApplicationDatabases
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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:
- name: database1
- name: database2
_links:
filter:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases
sort:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-databases'
description: OK
'404':
content:
application/hal+json:
examples:
No data or permission:
value:
error: not_found
message: The application 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: Databases do not exist on non-hosted applications.
Not available on Node.js:
value:
error: not_found
message: Databases do not exist on Node.js applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List Database Names for the Application.
tags:
- Applications
x-cli-name: applications:database-list
post:
description: This action will create a new database within each environment
of the application.
operationId: postApplicationDatabaseCreate
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
name: my_db_name
schema:
description: Application database name.
properties:
name:
description: The database name.
maxLength: 63
minLength: 1
type: string
required:
- name
type: object
application/x-www-form-urlencoded:
example:
name: my_db_name
schema:
description: Application database name.
properties:
name:
description: The database name.
maxLength: 63
minLength: 1
type: string
required:
- name
type: object
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69
parent:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1
self:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases
message: The database is being created.
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'
Name already in use:
value:
error: validation_failed
message:
name: A database with that name already exists. Please choose
another name.
Name can only be alphanumeric and underscores:
value:
error: validation_failed
message:
name: The database name can only contain alphanumeric characters
and underscores.
Name cannot be default:
value:
error: validation_failed
message:
name: The database name cannot be "default".
Name cannot exceed 63 characters in length:
value:
error: validation_failed
message:
general: The database name cannot exceed 63 characters in length.
Not available on Site Factory applications:
value:
error: validation_failed
message:
general: Databases cannot be added on Acquia Cloud Site Factory
applications.
Only available for hosted applications:
value:
error: validation_failed
message:
general: Databases can only be added on Acquia-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
ACSF application:
value:
error: forbidden
message: Databases cannot be added to Acquia Cloud Site Factory
applications.
No permission:
value:
error: forbidden
message: You do not have permission to add a database to this
application.
Node.js application:
value:
error: forbidden
message: Databases cannot be added on Node.js applications.
Non-hosted application:
value:
error: forbidden
message: Databases cannot be added to non-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a Database.
tags:
- Applications
x-cli-name: applications:database-create
/applications/{applicationUuid}/databases/{name}:
delete:
description: This action will delete the database in ALL environments within
this application.
operationId: postApplicationDatabaseDelete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_name'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3
parent:
href: https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases
self:
href: https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases/testdatabase
message: The database is being deleted.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Can only be erased on free tier applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia Free Tier applications.
Can only be erased on hosted applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia-hosted applications.
Cannot delete default:
value:
error: validation_failed
message:
name: The database is a default database, and cannot be removed.
Does not belong to application:
value:
error: validation_failed
message:
name: The database does not belong to this application, and
cannot be removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
ACSF application:
value:
error: forbidden
message: Databases cannot be deleted on Acquia Cloud Site Factory
applications.
No permission:
value:
error: forbidden
message: You do not have permission to delete this database.
Node.js application:
value:
error: forbidden
message: Databases cannot be erased on Node.js applications.
Non hosted application:
value:
error: forbidden
message: Databases cannot be deleted on non-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Drops (deletes) a Database.
tags:
- Applications
x-cli-name: applications:database-delete
/applications/{applicationUuid}/databases/{name}/actions/erase:
post:
description: This action will delete all tables of the database in ALL environments
within this application.
operationId: postApplicationDatabaseErase
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_name'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3
parent:
href: https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions
self:
href: https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions/erase
message: The database is being erased.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Can only be erased on free tier applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia Free Tier applications.
Can only be erased on hosted applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia-hosted applications.
Does not belong to application:
value:
error: validation_failed
message:
name: The database does not belong to this application, and
cannot be removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
ACF only:
value:
error: forbidden
message: Only Acquia Cloud Free subscriptions can erase databases.
No permission:
value:
error: forbidden
message: You do not have permission to erase this database.
Node.js application:
value:
error: forbidden
message: Databases cannot be erased on Node.js applications.
Non-hosted application:
value:
error: forbidden
message: Databases cannot be erased on non-hosted applications.
Service Management-enabled application:
value:
error: forbidden
message: Databases cannot be erased on Service Management-enabled
applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Erases (truncates) a Database.
tags:
- Applications
x-cli-name: applications:database-erase
/applications/{applicationUuid}/email/domains:
get:
description: Returns a list of email domains associated with the application
and domains that have been verified at the subscription level.
operationId: getApplicationEmailDomains
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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:
- domain_name: example.com
flags:
associated: true
health:
code: '200'
details: ''
summary: OK
uuid: 123e4567-e89b-12d3-a456-426614174000
- domain_name: example2.com
flags:
associated: true
health:
code: '200'
details: ''
summary: OK
uuid: 123e4567-e89b-12d3-a456-426614174000
_links:
filter:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications123e4567-e89b-12d3-a456-426614174000/email/domains{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email
self:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains
sort:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?sort}
templated: true
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email-domains'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to manage email domains for
this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No data or permission:
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 Email Domains Associated with the Application.
tags:
- Applications
x-cli-name: applications:email-domains-list
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate:
post:
description: Associates an email domain with an Application.
operationId: postApplicationAssociateEmailDomain
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Associate Domain:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000
self:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000/actions/associate
message: The domain has been associated with the application.
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 permission to associate domains with
this application.
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 associate a domain
registration with does not exist or you do not have permission
to access it.
Domain not found:
value:
error: not_found
message: The domain registration you are trying to associate 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 associated:
value:
error: conflict
message: The domain example.com is already associated with this
application.
No entitlement:
value:
error: conflict
message: Platform Email 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 Associates an Email Domain with an Application.
tags:
- Applications
x-cli-name: applications:post-associate-email-domain
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate:
post:
description: Disassociates an email domain with an Application.
operationId: postApplicationDisassociateEmailDomain
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Disassociate Domain:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
self:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/dissasociate
message: The domain has been disassociated from the application.
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 permission to disassociate domains from
this application.
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 disassociate a domain
registration from does not exist or you do not have permission
to access it.
Domain not found:
value:
error: not_found
message: The domain registration you are trying to disassociate
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:
Domain minimum:
value:
error: conflict
message: The application must have at least one associated domain
while Platform Email is enabled on an environment.
No entitlement:
value:
error: conflict
message: Platform Email is not available for this subscription.
Not associated:
value:
error: conflict
message: The domain example.com is not associated with this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Disassociates an Email Domain with an Application.
tags:
- Applications
x-cli-name: applications:post-disassociate-email-domains
/applications/{applicationUuid}/environments:
get:
description: Returns a list of environments within this application.
operationId: getApplicationEnvironments
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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
active_domain: example.com
application:
name: Sample Drupal application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact: null
balancer: balancers
configuration:
operating_system: precise
php:
apcu: 32
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: 256
version: '8.3'
default_domain: sitedev.hosted.acquia-sites.com
domains:
- sitedev.hosted.acquia-sites.com
- example.com
flags:
cde: false
cdn: 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
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
- _links:
self:
href: https://cloud.acquia.com/api/environments/15-a47ac10b-58cc-4372-a567-0e02b2c3d470
active_domain: example.com
application:
name: Sample SiteFactory application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact: null
balancer: balancers
configuration: null
default_domain: siteprod.hosted.acquia-sites.com
domains:
- siteprod.hosted.acquia-sites.com
- example.com
flags:
cde: false
cdn: false
email: false
hsd: false
livedev: false
multi_region: false
multicert: false
production: true
production_mode: true
remote_admin: false
varnish: true
varnish_over_ssl: false
gardener:
multi-site: prod.example.com/admin/gardens/staging
site-update: prod.example.com/admin/gardens/site-update
id: 15-a47ac10b-58cc-4372-a567-0e02b2c3d470
image_url: null
ips:
- 10.0.1.1
- 10.0.1.2
label: Production
name: prod
platform: cloud
region: us-east-1
size: medium
ssh_url: site.prod@siteprod.ssh.hosted.acquia-sites.com
status: normal
type: drupal
vcs:
path: tags/01-01-2015
type: git
url: site@svn-3.hosted.acquia-sites.com:site.git
weight: 0
- _links:
self:
href: https://cloud.acquia.com/api/environments/32-a47ac10b-58cc-4372-a567-0e02b2c3d470
active_domain: test.example.com
application:
name: Sample Node application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact:
id: 1
name: Example artifact
balancer: balancers
configuration:
node:
version: 6.11.1
operating_system: precise
default_domain: sitetest.hosted.acquia-sites.com
domains:
- sitetest.hosted.acquia-sites.com
- test.example.com
flags:
cde: false
cdn: 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
id: 32-a47ac10b-58cc-4372-a567-0e02b2c3d470
image_url: null
ips: []
label: Stage
name: test
platform: cloud
region: us-east-1
size: medium
ssh_url: site.test@sitetest.ssh.hosted.acquia-sites.com
status: normal
type: node
vcs:
path: null
type: git
url: qa10@svn-3.networkdev.ahserversdev.com:qa10.git
weight: 20
_links:
filter:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments
sort:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environments'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: No environments 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 Returns a List of Environments Within This Application by its
UUID.
tags:
- Applications
x-cli-name: applications:environment-list
post:
description: Add a new continuous delivery environment.
operationId: postApplicationEnvironments
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
branch: my-feature-branch
databases:
- database1
- database2
label: CD label
schema:
properties:
branch:
description: The name of the branch or tag that the continuous delivery
environment will have.
type: string
databases:
description: An array containing the names of the databases to add
to the continuous delivery environment.
items:
type: string
type: array
label:
description: The new environment label.
type: string
required:
- label
- branch
- databases
type: object
application/x-www-form-urlencoded:
schema:
example:
branch: my-feature-branch
databases:
- database1
- database2
label: CD label
properties:
branch:
description: The name of the branch or tag that the continuous delivery
environment will have.
type: string
databases:
description: The names of the databases to add to the continuous
delivery environment.
items:
type: string
type: array
label:
description: The new environment label.
type: string
required:
- label
- branch
- databases
type: object
required: true
responses:
'202':
content:
application/hal+json:
examples:
Adding environment:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/23d9184d-40b8-4f21-a3d5-416aef9bcd39
parent:
href: https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments
self:
href: https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments
message: Adding an environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Application does not support CD environments:
value:
error: validation_failed
message:
general: This application does not support CD environments.
Application is at capacity:
value:
error: validation_failed
message:
general: This application already has the maximum number of
CD environments.
Application is not hosted by Acquia:
value:
error: validation_failed
message:
general: Environments can only be added on Acquia-hosted applications.
Databases do not exist:
value:
error: validation_failed
message:
general: One or more of the databases you have specified do
not exist in this application.
Label already exists:
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'
Too many databases exist:
value:
error: validation_failed
message:
general: You cannot provision more than 3 databases on your
new environment.
Too many databases provided:
value:
error: validation_failed
message:
general: Please specify 3 or fewer databases to provision on
your environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Application is not hosted by Acquia:
value:
error: forbidden
message: CD environments cannot be added to non-hosted applications.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to add an 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 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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Add a New Continuous Delivery Environment to an Application
by the Application UUID.
tags:
- Applications
x-cli-name: applications:environment-create
/applications/{applicationUuid}/features:
get:
description: 'Returns a list of feature flags for this application.
'
operationId: getApplicationFeatures
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- description: Allows access to Some feature.
label: Some feature.
name: feature-name
- description: Allows access to Example feature.
label: Example feature.
name: example-feature
_links:
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/features
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-features'
description: OK
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Application Features.
tags:
- Applications
x-cli-name: applications:feature-list
/applications/{applicationUuid}/ides:
get:
description: Returns a list of Cloud IDEs associated with this application.
operationId: getApplicationIdes
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _embedded:
owner:
created_at: '2016-08-14T17:38:59-04:00'
email: user.name@example.com
first_name: First
last_login_at: '2019-01-31T10:53:11-05:00'
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
_links:
application:
href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199
ide:
href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ides.acquia.com
self:
href: https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7
web:
href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud
label: IDE Label 1
status: active
uuid: 9a83c081-ef78-4dbd-8852-11cc3eb248f7
- _embedded:
owner:
created_at: '2016-08-14T17:38:59-04:00'
email: user.name@example.com
first_name: First
last_login_at: '2019-01-31T10:53:11-05:00'
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
_links:
application:
href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199
ide:
href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ides.acquia.com
self:
href: https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8
web:
href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud
label: IDE Label 2
status: active
uuid: feea197a-9503-4441-9f49-b4d420b0ecf8
_links:
parent:
href: https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8
self:
href: https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8/ides
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ides'
description: OK
'404':
content:
application/hal+json:
examples:
No application or permission:
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 Cloud IDEs Associated with This Application.
tags:
- Applications
x-cli-name: applications:ide-list
post:
description: Creates a new Cloud IDE.
operationId: postApplicationsIde
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
label: My new IDE
schema:
properties:
label:
description: The label of the Cloud IDE.
maxLength: 255
minLength: 1
type: string
required:
- label
type: object
application/x-www-form-urlencoded:
example:
label: My new IDE
schema:
properties:
label:
description: The label of the Cloud IDE.
maxLength: 255
minLength: 1
type: string
required:
- label
type: object
required: true
responses:
'202':
content:
application/hal+json:
examples:
IDE created:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/e47da6d7-371e-4bb9-a7fe-d9ab8aa899c3
parent:
href: https://cloud.acquia.com/api/ides
self:
href: https://cloud.acquia.com/api/ides/1792767d-1ee3-4b5f-83a8-334dfdc2b8a3
message: The Cloud IDE is being created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Bad IDE label:
value:
error: validation_error
message:
name: A Cloud IDE labeled My new IDE already exists.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'404':
content:
application/hal+json:
examples:
No user:
value:
error: not_found
message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76
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 New Cloud IDE.
tags:
- Applications
x-cli-name: ide:create
/applications/{applicationUuid}/messages:
get:
description: 'Filterable fields:
* `title`
* `message_type`
* `display_mode`
Sortable fields:
* `title`
* `message_type`
* `display_mode`
'
operationId: getApplicationMessages
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_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:
dismiss:
href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/dismiss
follow:
href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/follow
self:
href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623
body: This is the body of the IPM.
expire_at: '2015-12-05T13:30:00-05:00'
filters:
display_mode: bar
paths:
- /some/random/path
- /other/random/path
type: general
flags:
active: true
dismissed: false
dismissible: true
id: 123
start_at: '2015-11-05T00:30:00-05:00'
title: IPM Title
url: http://www.acquia.com
uuid: 77fedb64-b8c0-4712-90e3-f39b4716e623
weight: -1
- _links:
dismiss:
href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/dismiss
follow:
href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/follow
self:
href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2
body: IPM Message 2 body
expire_at: '2016-11-07T17:30:00-05:00'
filters:
display_mode: bar
paths: []
type: new
flags:
active: true
dismissed: false
dismissible: true
id: 234
start_at: '2015-11-07T17:30:00-05:00'
title: IPM Message 2
url: http://www.google.ca
uuid: c5328e00-282a-4bec-a3c8-4322d97545b2
weight: 0
_links:
filter:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?limit}
templated: true
self:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages
sort:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-messages'
description: OK
'404':
content:
application/hal+json:
examples:
No application or permission:
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 Messages Associated with This Application.
tags:
- Applications
x-cli-name: applications:message-list
/applications/{applicationUuid}/metrics/usage:
get:
description: Retrieves traversal links for an application's usage data.
operationId: getApplicationsUsageLinks
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
data:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data
data-by-environment:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
views:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
views-by-environment:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment
visits:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
visits-by-environment:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment
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 application.
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.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Traversal Links for Detailed Metrics on Usage (views
and Visits) of Your Application.
tags:
- Applications
x-cli-name: applications:usage-links
/applications/{applicationUuid}/metrics/usage/data:
get:
description: 'Filterable fields:
* `metric` - One of: {`views`, `visits`}
* `environment`
'
operationId: getApplicationsUsageData
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/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
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/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
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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 application.
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.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Aggregate Usage Data for an Application, Filterable
by Views or Visits and by Environment.
tags:
- Applications
x-cli-name: applications:usage-data
/applications/{applicationUuid}/metrics/usage/data-by-environment:
get:
description: 'Filterable fields:
* `metric` - One of: {`views`, `visits`}
* `environment`
'
operationId: getApplicationsUsageDataByEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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: []
last_data_at: null
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: []
last_data_at: null
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:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-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:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-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:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment
pagination:
limit: 6
offset: 0
total: 6
total: 6
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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 application.
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.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Usage Data (views or Visits) for an Application, Broken
Down by Environment.
tags:
- Applications
x-cli-name: applications:usage-data-by-environment
/applications/{applicationUuid}/metrics/usage/views-by-environment:
get:
description: 'Filterable fields:
* `environment`
'
operationId: getApplicationsUsageViewsDataByEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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: []
last_data_at: null
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/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-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:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment
pagination:
limit: 3
offset: 0
total: 3
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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 application.
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.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Views Data for an Application, Broken Down by Environment.
tags:
- Applications
x-cli-name: applications:usage-views-data-by-environment
/applications/{applicationUuid}/metrics/usage/visits-by-environment:
get:
description: 'Filterable fields:
* `environment`
'
operationId: getApplicationsUsageVisitsDataByEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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/visits
datapoints: []
last_data_at: null
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:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-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:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment
pagination:
limit: 3
offset: 0
total: 3
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-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 application.
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.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Visits Data for an Application, Broken Down by Environment.
tags:
- Applications
x-cli-name: applications:usage-visits-data-by-environment
/applications/{applicationUuid}/metrics/usage/{usageMetric}:
get:
description: 'Filterable fields:
* `environment`
'
operationId: getApplicationsUsageMetricData
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_usage-metric'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/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
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metric'
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 application.
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.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Aggregate Usage Metric Data (views or Visits) for
an Application..
tags:
- Applications
x-cli-name: applications:usage-metric-data
/applications/{applicationUuid}/notifications:
get:
description: 'Returns a list of notifications associated with this application.
A notification represents an item of work to be done, initiated by someone
(typically the current user) associated with the application.
Filterable fields:
* `event`
* `label`
* `description`
* `status`
* `author`
* `created_at`
* `completed_at`
Sortable fields:
* `event`
* `label`
* `description`
* `status`
* `author`
* `created_at`
* `completed_at`
'
operationId: getApplicationNotifications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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/notifications
self:
href: https://cloud.acquia.com/api/notifications/1bd3487e-71d1-4fca-a2d9-5f969b3d35c1
completed_at: '2019-07-29T20:47:13+00:00'
context:
application:
uuids:
- a027502b-ad6c-a48e-a7e8-aa0def7d25e1
author:
actual_uuid: 5391a8a9-d273-4f88-8114-7f884bbfe08b
uuid: 5391a8a9-d273-4f88-8114-7f884bbfe08b
user:
uuids:
- 5391a8a9-d273-4f88-8114-7f884bbfe08b
created_at: '2019-07-29T20:47:13+00:00'
description: '"Canary QA 11 - ACE" was added to your recent applications
list.'
event: ApplicationAddedToRecents
label: Application added to recents list
progress: 100
status: completed
uuid: 1bd3487e-71d1-4fca-a2d9-5f969b3d35c1
_links:
filter:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1
self:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications
sort:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?sort}
templated: true
pagination:
limit: 1
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-notifications'
description: OK
'404':
content:
application/hal+json:
examples:
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 Notifications Associated with This Application
by its UUID.
tags:
- Applications
x-cli-name: applications:notification-list
/applications/{applicationUuid}/permissions:
get:
description: Returns a list of permissions the user has for this application.
operationId: getApplicationPermissions
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- description: Grants the ability to enable or disable live development
and non-production work.
flags:
deprecated: false
group_label: Workflow
label: Pull and deploy code, files, or databases to non-production
environments
name: deploy to non-prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Deploy code, files, or databases to the production environment
name: deploy to prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Pull files or databases from the production environment
name: pull from prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files to non-production environments
name: move file to non-prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files to the production environment
name: move file to prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files from production environments
name: move file from prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files from non-production environments
name: move file from non-prod
- description: null
flags:
deprecated: true
group_label: Workflow
label: Clear Varnish cache for non-production environments
name: clear varnish on non-prod
- description: null
flags:
deprecated: true
group_label: Workflow
label: Clear Varnish cache for the production environment
name: clear varnish on prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Configure production environment
name: configure prod env
- description: null
flags:
deprecated: false
group_label: Workflow
label: Configure non-production environments
name: configure non-prod env
- description: null
flags:
deprecated: false
group_label: Workflow
label: Add an environment
name: add an environment
- description: null
flags:
deprecated: false
group_label: Workflow
label: Delete an environment
name: delete an environment
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove domains for non-production environments
name: administer domain non-prod
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove domains for the production environment
name: administer domain prod
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove SSL certificates for the production environment
name: administer ssl prod
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove SSL certificates for the non-production environments
name: administer ssl non-prod
- description: null
flags:
deprecated: false
group_label: Server administration
label: Reboot server
name: reboot server
- description: Increasing the size of your server costs money.
flags:
deprecated: false
group_label: Server administration
label: Resize server
name: resize server
- description: null
flags:
deprecated: false
group_label: Server administration
label: Suspend server
name: suspend server
- description: null
flags:
deprecated: false
group_label: Server administration
label: Configure server
name: configure server
- description: null
flags:
deprecated: false
group_label: Logs
label: Download logs for non-production environments
name: download logs non-prod
- description: null
flags:
deprecated: false
group_label: Logs
label: Download logs for the production environment
name: download logs prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Add a database
name: add database
- description: null
flags:
deprecated: false
group_label: Databases
label: Remove a database
name: remove database
- description: null
flags:
deprecated: false
group_label: Databases
label: View database connection details (username, password, or
hostname)
name: view database connection
- description: null
flags:
deprecated: false
group_label: Databases
label: Download database backups for non-production environments
name: download db backup non-prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Download database backups for the production environment
name: download db backup prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Create database backups for non-production environments
name: create db backup non-prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Create database backups for the production environment
name: create db backup prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Restore database backups for non-production environments
name: restore db backup non-prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Restore database backups for the production environment
name: restore db backup prod
- description: Granting this permission will give any user with
this role full permissions on this team.
flags:
deprecated: false
group_label: Administration
label: Add or remove a user of a team
name: administer team
- description: Grants the ability to use the API and bypass all
other permissions via command line tools.
flags:
deprecated: false
group_label: Administration
label: Access the Cloud API
name: access cloud api
- description: null
flags:
deprecated: false
group_label: Cron
label: Modify cron tasks for non-production environments
name: administer cron non-prod
- description: null
flags:
deprecated: false
group_label: Cron
label: Modify cron tasks for the production environment
name: administer cron prod
- description: null
flags:
deprecated: false
group_label: Support
label: Create a support ticket
name: create support ticket
- description: null
flags:
deprecated: false
group_label: Support
label: View and edit any support tickets for a subscription
name: edit any support ticket
- description: null
flags:
deprecated: false
group_label: Build
label: View Build plans
name: view build plans
- description: null
flags:
deprecated: false
group_label: Build
label: Edit Build plans
name: edit build plans
- description: null
flags:
deprecated: false
group_label: Build
label: Run Build plans
name: run build plans
- description: null
flags:
deprecated: false
group_label: SSH keys
label: Add SSH key to git repository
name: add ssh key to git
- description: null
flags:
deprecated: false
group_label: SSH keys
label: Add SSH key to non-production environments
name: add ssh key to non-prod
- description: null
flags:
deprecated: false
group_label: SSH keys
label: Add SSH key to the production environment
name: add ssh key to prod
- description: This permission is only relevant if your subscription
has remote administration.
flags:
deprecated: false
group_label: Administration
label: View Remote Administration
name: view remote administration
- description: This permission is only relevant if your subscription
has remote administration.
flags:
deprecated: false
group_label: Administration
label: Edit Remote Administration
name: edit remote administration
- description: null
flags:
deprecated: false
group_label: Workflow
label: Clear caches for the production environment
name: clear caches on prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Clear caches for non-production environments
name: clear caches on non-prod
_links:
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/permissions
flags:
administrator: false
total: 49
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-permissions'
description: OK
'404':
content:
application/hal+json:
examples:
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 Permissions the User Has for This Application
by its UUID.
tags:
- Applications
x-cli-name: applications:permission-list
/applications/{applicationUuid}/search:
get:
description: Does not return any data. Allows traversal to search entity endpoints.
operationId: getApplicationSearchList
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
config-sets:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905
self:
href: https://cloud.acquia.com/api/applications/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
application.
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 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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns a Traversal Endpoint for Search Entities for the Application.
tags:
- Applications
x-cli-name: applications:search:list
/applications/{applicationUuid}/search/config-sets:
get:
description: A collection of search configuration sets for an application.
operationId: getApplicationSearchConfigurationSets
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
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:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
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:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
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.12345ab6c7e8f90g12i1jk234l56mn79
application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
flags:
custom: true
id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn79
label: example-2
status: pending
_links:
filter:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
sort:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?sort}
templated: true
pagination:
limit: 3
offset: 0
total: 3
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-sets'
description: OK
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to view search configuration sets
for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
example:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns a Collection of Search Configuration Sets for an Application
tags:
- Applications
x-cli-name: applications:search:configuration-set-list
post:
description: Creates a search configuration set for an application.
operationId: postApplicationSearchConfigurationSets
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
multipart/form-data:
schema:
description: The archive file binary.
properties:
archive:
description: A binary file response
format: binary
type: string
required:
- archive
type: object
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/05fb83f1-59dd-4079-b9f3-ce9243a126ed
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
message: The search configuration set is being created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'400':
content:
application/hal+json:
examples:
Error during file upload:
value:
error: validation_failed
message:
general: An error occurred during file upload.
File exceeds size limit:
value:
error: validation_failed
message:
general: The uploaded file size exceeds the 10MB limit.
Request missing uploaded file:
value:
error: validation_failed
message:
general: The request does not contain an uploaded file.
Uploaded file is not a zip file:
value:
error: validation_failed
message:
general: The uploaded file is not a zip file.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'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:
example:
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:
example:
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 Creates a Search Configuration Set for an Application.
tags:
- Applications
x-cli-name: applications:search:configuration-set-create
/applications/{applicationUuid}/search/config-sets/{configurationSetId}:
delete:
description: Removes and deletes a specific search configuration set from an
application.
operationId: deleteApplicationSearchConfigurationSet
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_configuration-set-id'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/41aaeac7-7ead-4f39-b74c-42493e4dc27b
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
message: The search configuration set has been deleted.
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 configuration
sets for this application.
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 application you are trying to access does not exist,
or you do not have permission to access it.
No configuration set or not enough permissions:
value:
error: not_found
message: The search configuration set you are trying to access
does not exist, or you do not have permission to access it.
Search configuration set not available:
value:
error: not_found
message: The configuration set is not available for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
example:
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 Removes and Deletes a Specific Search Configuration Set from
an Application.
tags:
- Applications
x-cli-name: applications:search:configuration-set-delete
get:
description: A specific search configuration set.
operationId: getApplicationSearchConfigurationSet
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_configuration-set-id'
responses:
'200':
content:
application/hal+json:
example:
_links:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
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
health:
code: OK
details: No issues.
summary: Search index active
id: shared-1234567891011-121
label: example-0
status: active
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-set'
description: OK
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to view search configuration sets
for this application.
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 application you are trying to access does not exist,
or you do not have permission to access it.
No configuration set or not enough permissions:
value:
error: not_found
message: The search configuration set 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:
- Applications
x-cli-name: applications:search:configuration-set-find
/applications/{applicationUuid}/settings:
get:
description: Does not return any data. Allows traversal to settings groups endpoints.
operationId: getApplicationSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
hosting:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting
keys:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys
parent:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470
ra:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra
security:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_settings'
description: OK
'404':
content:
application/hal+json:
examples:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Available Settings for This Application.
tags:
- Applications
x-cli-name: applications:settings-list
/applications/{applicationUuid}/settings/hosting:
get:
deprecated: true
description: Returns the hosting settings for this application.
operationId: getApplicationHostingSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting
hosting_id: master:site
type: ace
uuid: abcd1234-1111-2222-3333-0e02b2c3d470
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_hosting-settings'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: not_found
message: You do not have permission to access the hosting settings.
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 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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Hosting Settings for This Application.
tags:
- Applications
x-cli-name: applications:hosting-settings-list
/applications/{applicationUuid}/settings/keys:
get:
deprecated: true
description: Returns the legacy product keys for this application.
operationId: getApplicationLegacyProductKeysSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys
acquia_connector:
identifier: ABCD-12345
key: 12345678f5325ea35d63a6c3debcd225
cloud_api:
key: 123456787987a135e2c143601328cbf1
username: abcd1234-1111-2222-3333-0e02b2c3d470
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_legacy-product-keys-settings'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to access these product keys.
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 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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Legacy Product Keys for This Application.
tags:
- Applications
x-cli-name: applications:legacy-product-key-find
/applications/{applicationUuid}/settings/ra:
get:
description: Returns the remote administration settings for this application.
operationId: getApplicationRemoteAdministrationSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra
application_uuid: abcd1234-1111-2222-3333-0e02b2c3d470
deploy_at: 2016-03-04T12:01:05-0500
deploy_environment: test
flags:
copy_database: true
copy_files: true
merge_tag: false
merge_branch: master
pause_until: 2016-03-04T12:01:05-0500
source_environment: prod
update_mode: full
update_type: core
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration-settings'
description: OK
'403':
content:
application/hal+json:
examples:
Does not have remote administration:
value:
error: forbidden
message: This application does not have remote administration.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view the remote administration
settings for this application.
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 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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Remote Administration Settings for This Application.
tags:
- Applications
x-cli-name: applications:ra-settings-find
put:
description: Modifies the remote administration settings for an application.
operationId: putApplicationRemoteAdministrationSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
copy_database: true
copy_files: false
deploy_at: '2020-10-13 13:00:00'
deploy_environment: test
merge_branch: master
merge_tag: false
pause_until: '2021-10-10 13:00:00'
source_environment: prod
update_mode: update
update_type: core_contrib
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration'
application/x-www-form-urlencoded:
example:
copy_database: true
copy_files: false
deploy_at: '2020-10-13 13:00:00'
deploy_environment: test
merge_branch: master
merge_tag: false
pause_until: '2021-10-10 13:00:00'
source_environment: prod
update_mode: update
update_type: core_contrib
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration'
required: true
responses:
'200':
content:
application/hal+json:
example:
message: The remote administration settings have been updated
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'400':
content:
application/hal+json:
examples:
Deploy environment does not belong to application:
value:
error: validation_failed
message:
deploy_environment: The deploy environment does not belong to
this application.
Invalid deploy environment:
value:
error: validation_failed
message:
deploy_environment: The deploy environment is not valid.
Invalid remote administration mode:
value:
error: validation_failed
message:
update_mode: The remote administration mode 'something' is invalid.
Must be one of 'update', 'inform', or 'none'.
Invalid remote administration update type:
value:
error: validation_failed
message:
update_type: The remote administration update type 'something'
is invalid. Must be one of 'core' or 'core_contrib'.
Invalid source environment:
value:
error: validation_failed
message:
deploy_environment: The source environment is not valid.
No parameters:
value:
error: validation_failed
message:
general: No fields were set to update. No action performed.
Pause until must be in the future:
value:
error: validation_failed
message:
pause_until: The pause until timestamp must be in the future.
Remote administration not availble for application:
value:
error: validation_failed
message:
general: Remote administration is not available for this application.
Source environment does not belong to application:
value:
error: validation_failed
message:
deploy_environment: The source environment does not belong to
this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Does not have remote administration:
value:
error: forbidden
message: This application does not have remote administration.
Remote administration not available:
value:
error: forbidden
message: Remote admin is not available on non-hosted applications.
Unsufficient permissions:
value:
error: forbidden
message: You do not have permission to edit the remote administration
settings for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found or does not exist:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Modifies the Remote Administration Settings for an Application.
tags:
- Applications
x-cli-name: applications:ra-settings-update
/applications/{applicationUuid}/settings/security:
get:
deprecated: true
description: Returns the security policy settings for this application.
operationId: getApplicationSecuritySettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security
allowed_ips:
- 127.0.0.1
- 8.8.8.8
application_uuid: abcd1234-1111-2222-3333-0e02b2c3d470
tfa_required: true
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_security-settings'
description: OK
'404':
content:
application/hal+json:
examples:
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
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Security Policy Settings for This Application.
tags:
- Applications
x-cli-name: applications:security-settings-find
put:
deprecated: true
description: Modifies the security policy settings for an application.
operationId: putApplicationSecuritySettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
configuration_set: true
status:
- 127.0.0.1
- 0.0.0.0
schema:
properties:
allowed_ips:
description: 'The list of IPs to whitelist. Set to `null` to disable
IP whitelisting.
'
items:
format: ipv4
type: string
nullable: true
type: array
tfa_required:
description: The configuration set to use.Whether TFA is required
for application authentication.
type: boolean
type: object
application/x-www-form-urlencoded:
schema:
example:
configuration_set: true
status:
- 127.0.0.1
- 0.0.0.0
properties:
allowed_ips:
description: 'The list of IPs to whitelist. Set to `null` to disable
IP whitelisting.
'
items:
format: ipv4
type: string
nullable: true
type: array
tfa_required:
description: The configuration set to use.Whether TFA is required
for application authentication.
type: boolean
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
message: The security policy settings have been updated.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'400':
content:
application/hal+json:
examples:
Invalid IP address in list:
value:
error: validation_failed
message:
allowed_ips: The IP address \"not-a-valid-ip-address\" is invalid.
Invalid IP list:
value:
error: validation_failed
message:
allowed_ips: The list of allowed IPs is invalid. Must either
be an array of IPs to whitelist, or null to disable IP whitelisting.
No parameters:
value:
error: validation_failed
message:
general: No fields 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:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to edit the security policy
settings for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found or does not exist:
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:
Action unavailable:
value:
error: conflict
message: The security policy is already configured to these settings.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Modifies the Security Policy Settings for an Application.
tags:
- Applications
x-cli-name: applications:security-settings-update
/applications/{applicationUuid}/tags:
get:
description: Returns a list of application tags associated with this application.
operationId: getApplicationTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags/Dev
color: orange
context:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
organization:
uuids:
- 2375e327-3fff-11e3-9170-12313920a02c
name: Dev
_links:
filter:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags
sort:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?sort}
templated: true
pagination:
limit: 1
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tags'
description: OK
'404':
content:
application/hal+json:
examples:
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 Application Tags Associated with This Application.
tags:
- Applications
x-cli-name: applications:tag-list
post:
description: Creates a new application tag.
operationId: postApplicationsTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
color: green
name: Dev
schema:
description: Application tags.
properties:
color:
description: The color name of the application tag found via the
GET /api/options/colors endpoint.
type: string
name:
description: The label of the application tag.
maxLength: 16
minLength: 2
type: string
required:
- name
- color
type: object
application/x-www-form-urlencoded:
example:
color: green
name: Dev
schema:
description: Application tags.
properties:
color:
description: The color name of the application tag found via the
GET /api/options/colors endpoint.
type: string
name:
description: The label of the application tag.
maxLength: 16
minLength: 2
type: string
required:
- name
- color
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/773fca86-9d87-45dc-9220-9ba38306bbb1
parent:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb
self:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags
message: The tag has been added to the application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'404':
content:
application/hal+json:
examples:
No user:
value:
error: not_found
message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76
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 New Application Tag.
tags:
- Applications
x-cli-name: applications:tags-create
/applications/{applicationUuid}/tags/{tagName}:
delete:
description: Deletes an application tag.
operationId: deleteApplicationTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_tag-name'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/37cdf705-9774-4526-9bf0-9feb279630ee
parent:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags
self:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags/test_tag
message: The tag has been removed from the application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'404':
content:
application/hal+json:
examples:
No user:
value:
error: not_found
message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76
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 an Application Tag.
tags:
- Applications
x-cli-name: applications:tags-delete
/applications/{applicationUuid}/tasks:
get:
description: 'Returns a list of tasks associated with this application. A task
represents an item of work to be done, initiated by someone (typically the
current user) associated with the application.
Filterable fields:
* `name`
* `title`
* `created`
* `completed`
* `started`
Sortable fields:
* `name`
* `title`
* `created`
* `completed`
* `started`
'
operationId: getApplicationTasks
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $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/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/8c6dde1f-fd0c-45e3-b6a3-f335397a1a76
completed_at: '2019-04-16T13:24:55-04:00'
created_at: '2019-04-16T13:24:55-04:00'
description: Application Example Application has been added to
team Example Team
id: 8c6dde1f-fd0c-45e3-b6a3-f335397a1a76
labels:
- teams
metadata:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
author:
actual_uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
created: 1555435495
organization:
uuids:
- 1734f8b7-9fd0-4150-92a8-325c52229554
subscription:
uuids:
- bbb28c3b-5eba-41ce-b54e-798d60f02a14
team:
uuids:
- e1cc8591-1f28-44d4-912a-371311ac6095
user:
uuids:
- d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
name: ApplicationAddedToTeam
progress: 100
reference_uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
started_at: '2019-04-16T13:24:55-04:00'
status: completed
title: Application added to team.
type: task
user:
created_at: '2015-08-14T17:37:21-04:00'
first_name: Example
last_login_at: '2019-05-23T16:12:12-04:00'
last_name: User
mail: example.user@example.com
picture_url: https://accounts.acquia.com/images/users/d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a/style/avatar
username: example.user
uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
uuid: 8c6dde1f-fd0c-45e3-b6a3-f335397a1a76
- _links:
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/a0b253b7-df89-4b45-950b-f1d1e8873d30
completed_at: '2019-01-25T04:24:46-05:00'
created_at: '2019-01-25T04:24:32-05:00'
description: Files copied from "prod" to "dev".
id: a0b253b7-df89-4b45-950b-f1d1e8873d30
labels:
- hosting
metadata:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
author:
actual_uuid: 66597696-118c-4e18-b7e8-d027df8d5faa
uuid: 66597696-118c-4e18-b7e8-d027df8d5faa
created: 1548408272
environment:
ids:
- 925-185f07c7-9c4f-407b-8968-67892ebcb38a
- 927-185f07c7-9c4f-407b-8968-67892ebcb38a
source: 925-185f07c7-9c4f-407b-8968-67892ebcb38a
target: 927-185f07c7-9c4f-407b-8968-67892ebcb38a
hosting:
task:
id: '12345678'
master: example
organization:
uuids:
- 1734f8b7-9fd0-4150-92a8-325c52229554
subscription:
uuids:
- bbb28c3b-5eba-41ce-b54e-798d60f02a14
user:
uuids:
- 66597696-118c-4e18-b7e8-d027df8d5faa
name: FilesCopied
progress: 0
reference_uuid: a0b253b7-df89-4b45-950b-f1d1e8873d30
started_at: '2019-01-25T04:24:32-05:00'
status: completed
title: Files copied
type: task
user:
created_at: '2015-08-13T19:37:00-04:00'
first_name: Example
last_login_at: '2019-05-30T18:08:36-04:00'
last_name: User
mail: example.user.2@example.com
picture_url: https://accounts.acquia.com/images/users/66597696-118c-4e18-b7e8-d027df8d5faa/style/avatar
username: example.user.2
uuid: 66597696-118c-4e18-b7e8-d027df8d5faa
uuid: a0b253b7-df89-4b45-950b-f1d1e8873d30
_links:
filter:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks
sort:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-tasks'
description: OK
'404':
content:
application/hal+json:
examples:
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 Tasks Associated with This Application by
its UUID.
tags:
- Applications
x-cli-name: applications:task-list
/applications/{applicationUuid}/teams:
get:
description: 'Returns a list of teams associated with this application by its
UUID.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getApplicationTeams
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_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:
self:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c
created_at: 2013-10-28T14:16:07-0700
name: Team Name 1
organization:
name: Sample Organization
uuid: 2375e327-3fff-11e3-9170-12313920a02c
updated_at: 2015-02-19T08:53:10-0800
uuid: abcd1234-82b5-11e3-9170-12313920a02c
- _links:
self:
href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f
created_at: 2014-05-27T11:55:39-0700
name: Team Name 2
organization:
name: Sample Organization
uuid: 2375e327-3fff-11e3-9170-12313920a02c
updated_at: 2015-01-30T05:49:16-0800
uuid: 1234abcd-82b5-11e3-9170-12313920a02c
_links:
parent:
href: https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8
self:
href: https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8/teams
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-teams'
description: OK
'404':
content:
application/hal+json:
examples:
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 Teams Associated with This Application.
tags:
- Applications
x-cli-name: applications:team-list
servers: []
tags:
- name: Applications