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 - Subscriptions
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
openapi: 3.0.0
paths:
/subscriptions:
get:
description: 'Filterable fields:
* `from`
* `to`
* `sort`
* `filter`
* `limit`
* `offset`
Sortable fields:
* `from`
* `to`
* `sort`
* `filter`
* `limit`
* `offset`
'
operationId: getSubscriptions
parameters:
- $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:
- _embedded:
organization:
_links:
parent:
href: https://cloud.acquia.com/api/organizations
self:
href: https://cloud.acquia.com/api/organizations/39f38840-c494-4622-80a5-fc40269cb42d
name: Acquia Inc.
uuid: 39f38840-c494-4622-80a5-fc40269cb42d
_links:
self:
href: https://cloud.acquia.com/api/subscriptions/faa297f3-f59a-4abc-8d71-904f51bcb1c5
applications_total: 3
applications_used: 1
expire_at: '2015-11-11T00:00:00'
flags:
active: true
expired: true
zuora: false
id: 123
name: Acquia Cloud Free Subscription
organization:
name: Acquia Inc.
uuid: 39f38840-c494-4622-80a5-fc40269cb42d
product:
id: 1890149
name: Acquia Cloud Free
type: free
start_at: '2011-03-28T00:00:00'
uuid: faa297f3-f59a-4abc-8d71-904f51bcb1c5
- _embedded:
organization:
_links:
parent:
href: https://cloud.acquia.com/api/organizations
self:
href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e
name: My Organization
uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
_links:
self:
href: https://cloud.acquia.com/api/subscriptions/36496037-6eb5-482d-8549-e45e1718f2b7
applications_total: 5
applications_used: 2
expire_at: '2015-05-15T12:00:00Z'
flags:
active: true
expired: true
zuora: false
id: 222
name: My Acquia Subscription
organization:
name: My Organization
uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
product:
id: 8999
name: Enterprise
type: enterprise
start_at: '2012-05-15T12:00:00Z'
uuid: 36496037-6eb5-482d-8549-e45e1718f2b7
- _embedded:
organization:
_links:
parent:
href: https://cloud.acquia.com/api/organizations
self:
href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e
name: My Organization
uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
_links:
self:
href: https://cloud.acquia.com/api/subscriptions/2d92f652-882c-458a-8183-4d9cef7c2fde
applications_total: 5
applications_used: 2
expire_at: '2015-05-15T12:00:00Z'
flags:
active: true
expired: true
zuora: false
id: 333
name: My Acquia Subscription 2
organization:
name: My Organization
uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
product:
id: 8999
name: Enterprise
type: enterprise
start_at: '2012-05-15T12:00:00Z'
uuid: 2d92f652-882c-458a-8183-4d9cef7c2fde
_links:
filter:
href: https://cloud.acquia.com/api/subscriptions{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/subscriptions{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/
self:
href: https://cloud.acquia.com/api/subscriptions
sort:
href: https://cloud.acquia.com/api/subscriptions{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscriptions'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: You do not have permission to view subscriptions.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Return a List of Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:list
/subscriptions/{subscriptionUuid}:
get:
description: Return details about a specific subscription.
operationId: getSubscription
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
organization:
_links:
parent:
href: https://cloud.acquia.com/api/organizations
self:
href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e
name: My Organization
uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
_links:
applications:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications
entitlements:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements
ides:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/ides
parent:
href: https://cloud.acquia.com/api/subscriptions
self:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a
shield-acl:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/shield-acl
applications_total: 10
applications_used: 0
expire_at: '2018-05-12T00:00:00'
flags:
active: true
expired: true
zuora: false
id: 329876
name: My Subscription
organization:
name: My Organization
uuid: 93c97126-2870-47f0-9ffd-9a92033c443e
product:
id: 8999
name: Enterprise
type: enterprise
start_at: '2015-05-13T00:00:00'
uuid: 8533debb-ae4e-427b-aa34-731719b4201a
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription'
description: OK
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:find
put:
description: Modifies a subscription.
operationId: putSubscription
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
name:
description: The new subscription name.
maxLength: 255
type: string
type: object
required: true
responses:
'200':
content:
application/hal+json:
examples:
Subscription updated:
value:
message: Subscription updated.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
Validation failed:
value:
error: not_found
message: The subscription 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 a Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:update
/subscriptions/{subscriptionUuid}/applications:
get:
description: 'Filterable fields:
* `from`
* `to`
* `sort`
* `filter`
* `limit`
* `offset`
Sortable fields:
* `from`
* `to`
* `sort`
* `filter`
* `limit`
* `offset`
'
operationId: getSubscriptionApplications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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
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
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
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
_links:
filter:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a
self:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications
sort:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?sort}
templated: true
pagination:
limit: 10
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-applications'
description: OK
'404':
content:
application/hal+json:
example:
error: not_found
message: You do not have permission to view applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Provides a List of Applications That Are a Part of the Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:application-list
/subscriptions/{subscriptionUuid}/code-studio:
get:
description: Retrieves Code Studio metadata for a subscription.
operationId: getCodeStudioSubscriptionMetadata
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
subscription:
_links:
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
name: My Subscription
uuid: e5bfb18f-2c6c-4534-bb9b-15ba73e17342
_links:
applications:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications
code-studio:
href: https://code.acquia.com
code-studio-api:
href: https://code.acquia.com/api/v4
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio
subscription:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
users:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
status: active
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-subscription-metadata'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 Code Studio Metadata for a Subscription.
tags:
- Subscriptions
options:
description: Displays Code Studio options for a subscription.
operationId: optionsCodeStudio
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio
roles:
4a996644-5a6e-4403-9306-6c08cb212ee1: Developer
90abb6cc-f609-41db-a92d-1900b1c7d93f: Maintainer
a9bdb481-63f4-4770-93ee-bf6c630238cf: Guest
c6c76597-dd30-4149-8a76-3c58d764bc66: Reporter
e62722c0-64dc-4d87-88ac-9f7bef645572: Owner
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-options'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription you are trying to access does not exist,
or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Displays Code Studio Options for a Subscription.
tags:
- Subscriptions
/subscriptions/{subscriptionUuid}/code-studio/actions/enable:
post:
description: Enables and provisions Code Studio at the subscription level.
operationId: postEnableCodeStudio
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/34c7ed7e-2db8-433f-b6a8-96bc1080e3c9
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/actions/enable
message: Code Studio has been enabled for the Subscription.
notification_id: 34c7ed7e-2db8-433f-b6a8-96bc1080e3c9
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 enable Code Studio for
this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription you are trying to access does not exist,
or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Enables Code Studio for a Subscription.
tags:
- Subscriptions
/subscriptions/{subscriptionUuid}/code-studio/applications:
get:
description: Retrieves a list of Code Studio enabled applications for a subscription.
operationId: getCodeStudioApplications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _embedded:
project:
_links:
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/b91be25b-8eba-4ff7-94c8-d51637da2343
self:
href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343/code-studio
application_id: b91be25b-8eba-4ff7-94c8-d51637da2343
status: active
_links:
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
project:
href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343/code-studio
self:
href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343
name: My Application
uuid: b91be25b-8eba-4ff7-94c8-d51637da2343
_links:
code-studio:
href: https://code.acquia.com
code-studio-api:
href: https://code.acquia.com/api/v4
filter:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1{&filter}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1
sort:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1{&sort}
templated: true
pagination:
limit: 10
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-applications'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 a List of Code Studio Enabled Applications for a Subscription.
tags:
- Subscriptions
/subscriptions/{subscriptionUuid}/code-studio/users:
get:
description: Retrieves a list of users assigned to Code Studio for a subscription.
operationId: getCodeStudioUsers
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
code-studio:
href: https://code.acquia.com
code-studio-api:
href: https://code.acquia.com/api/v4
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users/cc27c5b6-d641-4e72-8897-75874ecf82e6
first_name: Jane
last_name: Doe
mail: jane.doe@test.com
role: b3d8e9f1-8cb6-43c0-b579-0c465f5fdf49
uuid: cc27c5b6-d641-4e72-8897-75874ecf82e6
_links:
code-studio:
href: https://code.acquia.com
code-studio-api:
href: https://code.acquia.com/api/v4
filter:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users{?filter}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
sort:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users{?sort}
templated: true
pagination:
limit: 10
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-users'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 a List of Users Assigned to Code Studio for a Subscription.
tags:
- Subscriptions
post:
description: Assigns a user to Code Studio seat for a subscription.
operationId: postCodeStudioUsers
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
requestBody:
content:
application/hal+json:
example:
role: ba8e9a8b-5e98-43b0-a0ec-40b2a813879a
user_id: 0b9bea4e-f469-44dd-a4b6-965aad734198
schema:
properties:
role:
description: The ID of the Code Studio role to assign to the user.
type: string
user_id:
description: The ID of the user to assign.
type: string
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/4e3cae56-5547-4ac7-b552-5dc87b50a8d3
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
message: A Code Studio user has been added to the Subscription.
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 add a Code Studio user
to this Subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 Assigns a User to a Code Studio Seat for a Subscription.
tags:
- Subscriptions
/subscriptions/{subscriptionUuid}/code-studio/users/{userUuid}:
delete:
description: Unassigns a user from a Code Studio seat.
operationId: deleteCodeStudioUser
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/4e3cae56-5547-4ac7-b552-5dc87b50a8d3
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
message: The Code Studio user is being removed from the Subscription.
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
user from this Subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 Unassigns a User from a Code Studio Seat.
tags:
- Subscriptions
get:
description: Retrieves details about a specific Code Studio user.
operationId: getCodeStudioUser
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
code-studio:
href: https://code.acquia.com
code-studio-api:
href: https://code.acquia.com/api/v4
parent:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users
self:
href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users/bd06a2fe-a103-400e-b397-b4d27538e1b3
first_name: Jane
last_name: Doe
mail: jane.doe@test.com
role: 90ad1576-84d9-43e5-b9db-0aad54dd5ade
uuid: bd06a2fe-a103-400e-b397-b4d27538e1b3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-user'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Code Studio user not found:
value:
error: not_found
message: The Code Studio user you are trying to access does not
exist, or you do not have permission to access it.
No subscription or permission:
value:
error: not_found
message: The subscription 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 Details About a Specific Code Studio User.
tags:
- Subscriptions
/subscriptions/{subscriptionUuid}/domains:
get:
description: Returns a list of Domains registered with this subscription.
operationId: getSubscriptionDomainRegistrations
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
dns_records:
- health:
code: '404'
details: Acquia could not verify the presence of the required
TXT DNS record
summary: Missing DNS record
name: _amazonses.example.com
type: TXT
value: AB/CD4Hef1+c0D7+wYS2xQ+EBr3HZiXRWDJHrjEWOhs=
- health:
code: '404'
details: Acquia could not verify the presence of the required
TXT DNS record
summary: Missing DNS record
name: _acquiaplatform.example.com
type: TXT
value: aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43=
- health:
code: '202'
details: Acquia is in the process of verifying SPF DNS records.
summary: Verification pending
name: mail.example.com
type: MX
value: 10 feedback-smtp.us-east-1.amazonses.com
- health:
code: '202'
details: Acquia is in the process of verifying SPF DNS records.
summary: Verification pending
name: mail.example.com
type: TXT
value: v=spf1 include:amazonses.com ~all
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
domain_name: example.com
health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM/SPF/TXT DNS record.
summary: Missing DNS record
uuid: 123e4567-e89b-12d3-a456-426614174000
- _links:
parent:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
dns_records:
- health:
code: '404'
details: Acquia could not verify the presence of the required
TXT DNS record
summary: Missing DNS record
name: _amazonses.example2.com
type: TXT
value: AB/CD4Hef1+c0D7+wYS2xQ+EBr3HZiXRWDJHrjEWOhs=
- health:
code: '404'
details: Acquia could not verify the presence of the required
TXT DNS record
summary: Missing DNS record
name: _acquiaplatform.example2.com
type: TXT
value: aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43=
- health:
code: '202'
details: Acquia is in the process of verifying SPF DNS records.
summary: Verification pending
name: mail.example2.com
type: MX
value: 10 feedback-smtp.us-east-1.amazonses.com
- health:
code: '202'
details: Acquia is in the process of verifying SPF DNS records.
summary: Verification pending
name: mail.example2.com
type: TXT
value: v=spf1 include:amazonses.com ~all
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example2.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example2.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example2.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
domain_name: example2.com
health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM/SPF/TXT DNS record.
summary: Missing DNS record
uuid: 123e4567-e89b-12d3-a456-426614174000
_links:
filter:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains
sort:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?sort}
templated: true
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registrations'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to manage domain registrations
for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 Domains Registered with This Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:domain-registrations-list
post:
description: Registers a Domain with this subscription.
operationId: postSubscriptionDomainRegistration
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
requestBody:
content:
application/hal+json:
example:
domain: example.com
schema:
properties:
domain:
description: The domain name to add.
format: hostname
maxLength: 253
minLength: 3
type: string
type: object
application/x-www-form-urlencoded:
example:
domain: example.com
schema:
properties:
domain:
description: The domain name to add.
maxLength: 253
minLength: 3
type: string
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
message: The domain has been registered.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to manage domain registrations
for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No domain or permission:
value:
error: not_found
message: The domain registration you are trying to access does
not exist, or you do not have permission to access it.
No subscription or permission:
value:
error: not_found
message: The subscription 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:
Domain limit:
value:
error: conflict
message: The maximum number of domains for Platform Email have
been registered.
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
summary: Acquia Registers a Domain with This Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:post-domain-registration
/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}:
delete:
description: Unregisters a Domain registered with this subscription.
operationId: deleteSubscriptionDomainRegistration
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
message: The domain has been unregistered from the subscription.
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 domains from this
subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No domain or permission:
value:
error: not_found
message: The domain you are trying to access does not exist, or
you do not have permission to access it.
No subscription or permission:
value:
error: not_found
message: The subscription 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:
Domain not registered:
value:
error: conflict
message: example.com is not registered with this subscription.
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
summary: Acquia Unregisters a Domain Registered with This Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:delete-domain-registration
get:
description: Returns a speicific Domain registered with this subscription.
operationId: getSubscriptionDomainRegistration
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
dns_records:
- health:
code: '404'
details: Acquia could not verify the presence of the required
TXT DNS record
summary: Missing DNS record
name: _amazonses.example.com
type: TXT
value: AB/CD4Hef1+c0D7+wYS2xQ+EBr3HZiXRWDJHrjEWOhs=
- health:
code: '404'
details: Acquia could not verify the presence of the required
TXT DNS record
summary: Missing DNS record
name: _acquiaplatform.example.com
type: TXT
value: aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43=
- health:
code: '202'
details: Acquia is in the process of verifying SPF DNS records.
summary: Verification pending
name: mail.example.com
type: MX
value: 10 feedback-smtp.us-east-1.amazonses.com
- health:
code: '202'
details: Acquia is in the process of verifying SPF DNS records.
summary: Verification pending
name: mail.example.com
type: TXT
value: v=spf1 include:amazonses.com ~all
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
- health:
code: '404'
details: Acquia could not verify the presence of the required
DKIM DNS record
summary: Missing DNS record
name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com
type: CNAME
value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com
domain_name: example.com
health:
code: '404'
details: Acquia could not verify the presence of the required DKIM/SPF/TXT
DNS record.
summary: Missing DNS record
uuid: 123e4567-e89b-12d3-a456-426614174000
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_domain-registration'
description: OK
'404':
content:
application/hal+json:
examples:
No domain or permission:
value:
error: not_found
message: The domain registration you are trying to access does
not exist, or you do not have permission to access it.
No subscription or permission:
value:
error: not_found
message: The subscription 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 Speicific Domain Registered with This Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:get-domain-registration
/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify:
post:
description: Triggers re-verification and update to the domain verification
status.
operationId: postSubscriptionVerifyDomainRegistration
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
self:
href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/verify
message: The domain status is being verified.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
No domain or permission:
value:
error: not_found
message: The domain registration 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: Forbidden
'404':
content:
application/hal+json:
examples:
No domain or permission:
value:
error: not_found
message: The domain registration you are trying to access does
not exist, or you do not have permission to access it.
No subscription or permission:
value:
error: not_found
message: The subscription with UUID 123e4567-e89b-12d3-a456-426614174000
does not exist.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
No entitlement:
value:
error: conflict
message: Platform Email is not available for this subscription.
Verification already pending:
value:
error: conflict
message: This domain cannot be reverified at this time.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
summary: Acquia Triggers Re-verification and Update to the Domain Verification
Status.
tags:
- Subscriptions
x-cli-name: subscriptions:post-verify-domain-registration
/subscriptions/{subscriptionUuid}/entitlements:
get:
description: Provides a list of entitlements that are a part of the subscription.
operationId: getSubscriptionEntitlements
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- expires_at: '2023-05-16T11:15:05+00:00'
flags:
trial: true
name: cde
offering_ids:
- b2a188df-00b7-47bf-a664-66835cde53b0
properties:
databases_total: 3
total: 10
used: 1
- expires_at: '2023-05-16T11:15:05+00:00'
flags:
trial: true
name: pipelines
offering_ids:
- b2a188df-00b7-47bf-a664-66835cde53b0
properties: []
- expires_at: '2023-05-16T11:15:05+00:00'
flags:
trial: true
name: newrelic
offering_ids:
- b2a188df-00b7-47bf-a664-66835cde53b0
properties:
id: 03816870a4724c900292bc9f0955a315
level: pro
- expires_at: '2023-05-16T11:15:05+00:00'
flags:
trial: true
name: log-forwarding
offering_ids:
- b2a188df-00b7-47bf-a664-66835cde53b0
properties: []
- expires_at: '2023-05-16T11:15:05+00:00'
flags:
trial: true
name: shield
offering_ids:
- b2a188df-00b7-47bf-a664-66835cde53b0
properties: []
- expires_at: '2023-05-16T11:15:05+00:00'
flags:
trial: true
name: consumption-based-pricing
offering_ids:
- b2a188df-00b7-47bf-a664-66835cde53b0
properties:
views: 500000000
visits: 10000000
_links:
parent:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a
self:
href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_entitlements'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The subscription you are trying to access does not exist,
or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Provides a List of Entitlements That Are a Part of the Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:entitlements-list
/subscriptions/{subscriptionUuid}/ides:
get:
description: Returns a list of Cloud IDEs associated with this subscription.
operationId: getSubscriptionIdes
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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/subscriptions/5d278c52-4876-4c70-a666-d671f77a602d
self:
href: https://cloud.acquia.com/api/subscriptions/5d278c52-4876-4c70-a666-d671f77a602d/ides
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ides'
description: OK
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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 Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:ide-list
/subscriptions/{subscriptionUuid}/metrics/usage:
get:
description: Retrieves traversal links for a subscription's usage data.
operationId: getSubscriptionsUsageLinks
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
data:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data
data-by-application:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application
parent:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
views:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views
views-by-application:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application
visits:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits
visits-by-application:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application
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 subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Subscription not found:
value:
error: not_found
message: The subscription 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 a Subscription's Usage Data.
tags:
- Subscriptions
x-cli-name: subscriptions:usage-links
/subscriptions/{subscriptionUuid}/metrics/usage/data:
get:
description: 'Filterable fields:
* `metric` - One of: {`views`, `visits`}
* `application`
* `from`
* `to`
'
operationId: getSubscriptionsUsageData
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/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
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/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
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data{?filter}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-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 subscription.
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 subscription 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 a Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:usage-data
/subscriptions/{subscriptionUuid}/metrics/usage/data-by-application:
get:
description: 'Filterable fields:
* `metric` - One of: {`views`, `visits`}
* `application`
'
operationId: getSubscriptionsUsageDataByApplication
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-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 for a Subscription, Broken Down by Application.
tags:
- Subscriptions
x-cli-name: subscriptions:usage-data-by-application
/subscriptions/{subscriptionUuid}/metrics/usage/views-by-application:
get:
description: 'Filterable fields:
* `application`
'
operationId: getSubscriptionsUsageViewsDataByApplication
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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:
filter:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-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 a Subscription, Broken Down by Application.
tags:
- Subscriptions
x-cli-name: subscriptions:usage-views-data-by-application
/subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application:
get:
description: 'Filterable fields:
* `application`
'
operationId: getSubscriptionsUsageVisitsDataByApplication
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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/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/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-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 a Subscription, Broken Down by Application.
tags:
- Subscriptions
x-cli-name: subscriptions:usage-visits-data-by-application
/subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}:
get:
description: 'Filterable fields:
* `application`
'
operationId: getSubscriptionsUsageMetricData
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_usage-metric'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-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/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage
self:
href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/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
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-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 for a Subscription.
tags:
- Subscriptions
x-cli-name: subscriptions:usage-metric-data
/subscriptions/{subscriptionUuid}/shield-acl:
get:
description: Provides a list of Shield ACL rules.
operationId: getShieldAcl
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $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/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl
self:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba2
action: allow
addresses:
- 127.0.0.82/32
- 127.0.0.83/32
description: My rule 1
service: ssh
status: active
subscription:
name: Example Subscription
uuid: 720d4df4-7469-47f2-9e42-a6a5152761bf
uuid: d5afa695-92a0-401b-b973-1f09992d6ba2
- _links:
parent:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl
self:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba3
action: allow
addresses:
- 192.168.2.2/24
description: My rule 2
service: ssh
status: active
subscription:
name: Example Subscription
uuid: 720d4df4-7469-47f2-9e42-a6a5152761bf
uuid: d5afa695-92a0-401b-b973-1f09992d6ba3
_links:
parent:
href: https://cloud.acquia.com/api/subscriptions/abcd1234-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/subscriptions/abcd1234-58cc-4372-a567-0e02b2c3d470/shield-acl
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_shield-acl-collection'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: not_found
message: You do not have permission to view the Shield ACL rules
for subscription d17b25bb-28dd-4a24-8f89-bfe8b1e151e9.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription you are trying to access does not exist,
or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Provides a List of Shield ACL Rules.
tags:
- Subscriptions
x-cli-name: subscriptions:shield-acl-list
post:
description: Creates a Shield ACL rule.
operationId: postShieldAcl
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
addresses:
description: A list of IP addresses and/or CIDRs for this Shield
ACL rule.
items:
description: An IP address and/or CIDRs for this Shield ACL rule.
type: string
type: array
description:
description: The description of the new Shield ACL rule.
maxLength: 255
minLength: 1
type: string
type: object
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/fbd0581d-7606-43d0-9d2e-4d9fa6570a0d
parent:
href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl
self:
href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl/bf8b6858-1e36-4b8e-bb05-35bdd986f5d2
message: Shield ACL rule for subscription has been created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Acquia Shield not available:
value:
error: validation_failed
message:
general: Shield rules can only be added to subscriptions that
have Acquia Shield.
Maximum Shield ACL rules:
value:
error: validation_failed
message:
general: You have already used the maximum number of Shield
rules for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: You do not have permission to create a new Shield ACL
rule.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription or permission:
value:
error: not_found
message: The subscription 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:
Shield ACL updates in progress:
value:
error: conflict
message:
general: Shield ACL rules cannot be created while ACL rule updates
are in progress.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a Shield ACL Rule.
tags:
- Subscriptions
x-cli-name: subscriptions:shield-acl-create
/subscriptions/{subscriptionUuid}/shield-acl/actions/reset:
post:
description: 'Resets the Shield ACL rules for a subscription to the default
settings. This action is irreversible and will remove all custom rules.
This operation can only be performed on subscriptions that have Acquia Shield
enabled. If there are ongoing updates to the Shield ACL rules, this operation
will fail with a conflict error.
'
operationId: postResetShieldAcl
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/a894467e-8ea2-4b0d-9b03-27909098ee3a
parent:
href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019
self:
href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl
message: Shield ACL rules reset for subscription with UUID 94afc849-3b5a-49cd-bcae-464333994019.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Acquia Shield not available:
value:
error: validation_failed
message:
general: Shield rules can only be reset on subscriptions that
have Acquia Shield.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to reset Shield ACL rules.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription:
value:
error: not_found
message: A subscription with UUID 720d4df4-7469-47f2-9e42-a6a5152761bf
cannot be found.
No subscription or permission:
value:
error: not_found
message: The subscription 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:
Shield ACL updates in progress:
value:
error: conflict
message:
general: Shield ACL rules cannot be reset while ACL rule updates
are in progress.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Conflict
summary: Acquia Resets Shield ACL Rules to Default Settings.
tags:
- Subscriptions
x-cli-name: subscriptions:shield-acl-reset
/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}:
delete:
description: Deletes a Shield ACL rule.
operationId: deleteShieldAcl
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_shield-acl-uuid'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/98c1c68d-d33d-4340-8cd2-f32bdbf035f3
parent:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl
self:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/93136254-7d65-465c-82e9-5e92d74ae6b4
message: 'Deleted ACL rule (UUID: 93136254-7d65-465c-82e9-5e92d74ae6b4)
for subscription (UUID: 720d4df4-7469-47f2-9e42-a6a5152761bf).'
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Acquia Shield not available:
value:
error: validation_failed
message:
general: Shield rules can only be deleted from subscriptions
that have Acquia Shield.
Shield ACL rule not associated:
value:
error: validation_failed
message:
general: The Shield ACL Rule with UUID 638c13e7-0455-45de-ab63-def9d348d50f
does not belong to the subscription with UUID e3959c8a-f53d-49a1-adb7-acdc8e717940.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: unauthorized
message: You do not have permission to delete a Shield ACL rule.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No subscription:
value:
error: not_found
message: The subscription with UUID 720d4df4-7469-47f2-9e42-a6a5152761bf
does not exist.
No subscription or permission:
value:
error: not_found
message: The subscription 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:
Shield ACL updates in progress:
value:
error: conflict
message:
general: Shield ACL rules cannot be deleted while ACL rule updates
are in progress.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Deletes a Shield ACL Rule.
tags:
- Subscriptions
x-cli-name: subscriptions:shield-acl-delete
get:
description: Returns the specified Shield access control list (ACL) rule for
a subscription.
operationId: getShieldAclRuleByUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_shield-acl-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl
self:
href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba2
action: allow
addresses:
- 127.0.0.82/32
- 127.0.0.83/32
description: My rule 1
service: ssh
status: active
subscription:
name: Example Subscription
uuid: 720d4df4-7469-47f2-9e42-a6a5152761bf
uuid: d5afa695-92a0-401b-b973-1f09992d6ba2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_shield-acl'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to view the Shield ACL rules
for subscription 720d4df4-7469-47f2-9e42-a6a5152761bf
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No Shield Acl:
value:
error: not_found
message: The Shield ACL rule you are trying to access does not
exist, or you do not have permission to access it.
No subscription:
value:
error: not_found
message: The subscription 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 Specified Shield ACL Rule.
tags:
- Subscriptions
x-cli-name: subscriptions:shield-acl-find
put:
description: Updates a Shield ACL rule.
operationId: putShieldAcl
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_shield-acl-uuid'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
addresses:
description: A list of IP addresses and/or CIDRs for this Shield
ACL rule.
items:
description: An IP address and/or CIDRs for this Shield ACL rule.
type: string
type: array
description:
description: The description of the new Shield ACL rule.
maxLength: 255
minLength: 1
type: string
type: object
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/87ae4d57-24d6-4b4b-8552-d9658b4e2dea
parent:
href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl
self:
href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl/b23588f8-dbfa-4fb8-92a1-60e0dd08eee9
message: Updated ACL rule for subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to edit a Shield ACL rule.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Validation failed:
value:
error: not_found
message: The subscription 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:
Same values:
value:
error: conflict
message: The Shield ACL rule already contains the same values.
Validation failed:
value:
error: conflict
message: The Shield ACL rule is not active.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Updates a Shield ACL Rule.
tags:
- Subscriptions
x-cli-name: subscriptions:shield-acl-update
servers: []
tags:
- name: Subscriptions