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 - Account version: 2.0.0 x-logo: altText: Acquia Cloud backgroundColor: '#FFFFFF' url: assets/cloud-platform.svg openapi: 3.0.0 paths: /account: get: description: Returns details about your account. operationId: getAccount responses: '200': content: application/hal+json: example: _links: invites: href: https://cloud.acquia.com/api/account/invites messages: href: https://cloud.acquia.com/api/account/messages parent: href: https://cloud.acquia.com/api/ self: href: https://cloud.acquia.com/api/account tokens: href: https://cloud.acquia.com/api/account/tokens company: Acquia, Inc. country: United States created_at: '2016-07-17T20:35:25+00:00' features: - ci-pipelines - on-demand-environments first_name: Jane flags: active: true support: false tfa: true id: 1234567 job_function: IT Executive job_title: '' last_login_at: 2017-03-28T13:07:54-0500 last_name: Doe mail: jane.doe@example.com metadata: applications: recent: - recent_at: 2016-03-04T13:07:54-0500 uuid: 8b83a104-2f09-11e9-b210-d663bd873d93 - recent_at: 2016-03-04T12:01:07-0500 uuid: 8b83a104-2f09-11e9-b210-d663bd873d93 - recent_at: 2016-03-04T12:01:05-0500 uuid: 8b83a104-2f09-11e9-b210-d663bd873d93 starred: - 987c5c48-2f09-11e9-b210-d663bd873d93 - 9b684e30-2f09-11e9-b210-d663bd873d93 name: jane.doe phone: mobile: '5555555555' office: null tfa: '5555555555' picture_url: https://accounts.acquia.com/images/users/82cff7ec-2f09-11e9-b210-d663bd873d93/style/avatar state: Massachusetts timezone: America/New_York uuid: 82cff7ec-2f09-11e9-b210-d663bd873d93 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user' description: OK '404': content: application/hal+json: examples: Does not exist: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found summary: Acquia Returns Details About Your Account. tags: - Account x-cli-name: accounts:find /account/applications/{applicationUuid}/actions/mark-recent: post: description: Marks an application as recently viewed. UUIDs and timestamps of recent applications are present in the "account" endpoint. operationId: postAccountApplicationMarkRecent parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' responses: '200': content: application/hal+json: examples: Marked as recently viewed: value: message: The application has been marked as recently viewed. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Does not exist: value: error: not_found message: The application you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Already on the recently viewed list: value: error: conflict message: Unable to add an application to the recently viewed list. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Marks an Application as Recently Viewed. tags: - Account x-cli-name: accounts:application-mark-recent /account/applications/{applicationUuid}/actions/star: post: description: Stars an application. UUIDs of starred applications are present in the "account" endpoint. operationId: postAccountApplicationStar parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' responses: '200': content: application/hal+json: examples: Starred: value: message: The application has been starred. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Does not exist: value: error: not_found message: The application you are trying to access does not exist, or you do not have permission to access it. User does not have access: value: error: not_found message: The user does not have access to this application. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Unable to add: value: error: conflict message: The application has already been starred by this user. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Stars an Application. tags: - Account x-cli-name: accounts:application-star /account/applications/{applicationUuid}/actions/unstar: post: description: Removes an application from the user's starred list. UUIDs of starred applications are present in the "account" endpoint. operationId: postAccountApplicationUnstar parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' responses: '200': content: application/hal+json: examples: Starred: value: message: The application has been unstarred. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Does not exist: value: error: not_found message: The application you are trying to access does not exist, or you do not have permission to access it. User does not have access: value: error: not_found message: The user does not have access to this application. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Unable to add: value: error: conflict message: The application is not currently starred by this user. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Removes an Application from the User's Starred List. tags: - Account x-cli-name: accounts:application-unstar /account/applications/{applicationUuid}/has-permission: get: description: Returns whether your account has access to a specific application permission. operationId: getAccountApplicationHasPermission parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_permission' responses: '200': content: application/hal+json: example: _links: application: href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod access: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_has-permission' description: OK '403': content: application/hal+json: examples: Do not have permission: value: error: forbidden message: You do not have the 'example permission' permission 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. Permission not found: value: error: not_found message: The permission you are trying to look up does not exist. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Returns Whether Your Account Has Access to a Specific Application Permission. tags: - Account x-cli-name: accounts:application-has-permission /account/applications/{applicationUuid}/is-admin: get: description: Returns whether your account is an administrator for an application. operationId: getAccountApplicationIsAdministrator parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' responses: '200': content: application/hal+json: example: _links: application: href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-admin admin: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-administrator' description: OK '403': content: application/hal+json: examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this application. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Not found: value: error: not_found message: The application you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Returns Whether Your Account is an Administrator for an Application. tags: - Account x-cli-name: accounts:is-application-admin /account/applications/{applicationUuid}/is-owner: get: description: Returns whether your account is the owner for an application. operationId: getAccountApplicationIsOwner parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' responses: '200': content: application/hal+json: example: _links: application: href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-owner owner: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-owner' description: OK '404': content: application/hal+json: examples: Not found: value: error: not_found message: The application you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Returns Whether Your Account is the Owner for an Application. tags: - Account x-cli-name: accounts:is-application-owner /account/drush-aliases/download: get: description: Returns the drush aliases as a compressed archive download. operationId: getAccountDrushAliasesDownload parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_drush-version' responses: '200': content: application/gzip: schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file' description: OK '403': content: application/hal+json: examples: Version not supported: value: error: forbidden message: Only Drush 8 and 9 are supported. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: No Cloud API key found: value: error: not_found message: No Cloud API key found for user with email address test@example.com. No aliases found: value: error: not_found message: No Drush aliases found for user with email address test@example.com. No applications found: value: error: not_found message: No hosted applications found for user with email address test@example.com. User not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found summary: Acquia Returns the Drush Aliases as a Compressed Archive Download. tags: - Account x-cli-name: accounts:drush-aliases /account/ides: get: description: Returns a list of Cloud IDEs associated with the current user. operationId: getAccountIdes responses: '200': content: application/hal+json: example: _embedded: items: - _links: application: href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 ide: href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ide.ahdev.cloud 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 - _links: application: href: https://cloud.acquia.com/api/applications/cc26f963-6e9e-49df-a159-230f75e455aa ide: href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ide.ahdev.cloud 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/account self: href: https://cloud.acquia.com/api/account/ides total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ides' description: OK '404': content: application/hal+json: examples: User not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found summary: Acquia Returns a List of Cloud IDEs Associated with the Current User. tags: - Account x-cli-name: accounts:ide-list /account/invites: get: description: 'Gets a list of all organization admin and team invites that are pending for the current user. Filterable fields: * `mail` * `token` * `author` Sortable fields: * `mail` * `token` * `author` ' operationId: getAccountInvites 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: - _links: organization: href: https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/invites/eb947b2c-2fe0-11e9-b210-d663bd873d93 applications: - name: Example application uuid: a6a494aa-1316-4867-b681-95e3d77a6b34 author: first_name: Jane last_name: Doe mail: jane.doe@example.com picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com username: jane.doe uuid: 0f1915e8-cd84-4386-94b8-21926fc376f5 created_at: '2012-05-15T12:00:00Z' email: invitee@example.com flags: declined: false organization: name: Organization Name uuid: e83c3532-2fe0-11e9-b210-d663bd873d93 roles: - name: Senior Developer uuid: fe79cb7a-2fe0-11e9-b210-d663bd873d93 team: name: Team Name uuid: 01d73cf8-2fe1-11e9-b210-d663bd873d93 token: dd9ea69fdcb6bee08b31a858b85535ec uuid: eb947b2c-2fe0-11e9-b210-d663bd873d93 - _links: organization: href: https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/invites/0540f4ba-2fe1-11e9-b210-d663bd873d93 author: first_name: Jane last_name: Doe mail: jane.doe@example.com picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com username: jane.doe uuid: 0f1915e8-cd84-4386-94b8-21926fc376f5 created_at: '2012-05-15T12:00:00Z' email: invitee@example.com flags: declined: false organization: name: Organization Name uuid: e83c3532-2fe0-11e9-b210-d663bd873d93 token: dd9ea69fdcb6bee08b31a858b85535ec uuid: 0540f4ba-2fe1-11e9-b210-d663bd873d93 _links: parent: href: https://cloud.acquia.com/api/account self: href: https://cloud.acquia.com/api/account/invites total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_account-invites' description: OK '404': content: application/hal+json: examples: User not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Gets a List of All Organization Admin and Team Invites That Are Pending for the Current User. tags: - Account x-cli-name: accounts:invites-list /account/messages: get: description: 'Returns a list of messages associated with the current user. Filterable fields: * `title` * `message_type` * `display_mode` Sortable fields: * `title` * `message_type` * `display_mode` ' operationId: getAccountMessages 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: - _links: dismiss: href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss follow: href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow self: href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2 body: null expire_at: '2019-07-15T09:45:00-04:00' filters: display_mode: bar paths: [] type: alert flags: active: true dismissed: false dismissible: true id: 883581 start_at: '2019-07-07T09:45:00-04:00' title: Example title url: null uuid: 17ff551f-a037-4c0a-a0cb-ad6616ab3aa3 weight: -1 - _links: dismiss: href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss follow: href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow self: href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2 body: null expire_at: '2019-07-15T09:45:00-04:00' filters: display_mode: bar paths: [] type: alert flags: active: true dismissed: false dismissible: true id: 883581 start_at: '2019-07-07T09:45:00-04:00' title: Another example title url: null uuid: 17ff551f-a037-4c0a-a0cb-ad6616ab3aa3 weight: -1 _links: filter: href: https://cloud.acquia.com/api/messages{?filter} templated: true limit: href: https://cloud.acquia.com/api/messages{?limit} templated: true offset: href: https://cloud.acquia.com/api/messages{?offset} templated: true parent: href: https://cloud.acquia.com/api/ self: href: https://cloud.acquia.com/api/messages sort: href: https://cloud.acquia.com/api/messages{?sort} templated: true pagination: limit: 2 offset: 0 total: 2 total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-messages' description: OK '404': content: application/hal+json: examples: Messages not found: value: error: not_found message: The messages you are trying to view do not exist, or you do not have permission to access them. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Returns a List of Messages Associated with the Current User. tags: - Account x-cli-name: accounts:messages-list /account/organizations/{organizationUuid}/is-admin: get: description: Returns whether your account is an administrator for an organization. operationId: getAccountOrganizationIsAdministrator parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid' responses: '200': content: application/hal+json: example: _links: organization: href: https://cloud.acquia.com/api/organizations/2026962e-2fe4-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/account/organizations/2026962e-2fe4-11e9-b210-d663bd873d93/is-admin admin: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-administrator' description: OK '403': content: application/hal+json: examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this organization. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Not found: value: error: not_found message: The organization 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 Whether Your Account is an Administrator for an Organization. tags: - Account x-cli-name: accounts:is-organization-admin /account/organizations/{organizationUuid}/is-owner: get: description: Returns whether your account is the owner for an organization. operationId: getAccountOrganizationIsOwner parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid' responses: '200': content: application/hal+json: example: _links: organization: href: https://cloud.acquia.com/api/organizations/2026962e-2fe4-11e9-b210-d663bd873d93 self: href: https://cloud.acquia.com/api/account/organizations/2026962e-2fe4-11e9-b210-d663bd873d93/is-owner owner: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-owner' description: OK '404': content: application/hal+json: examples: Not found: value: error: not_found message: The organization 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 Whether Your Account is the Owner for an Organization. tags: - Account x-cli-name: accounts:is-organization-owner /account/password: post: description: Verifies that the supplied password matches the current user's password. operationId: postAccountPassword requestBody: content: application/hal+json: example: password: mysupersecretpassword schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_password' application/x-www-form-urlencoded: example: password: mysupersecretpassword schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_password' required: true responses: '200': content: application/hal+json: example: valid: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_password-validation' description: OK security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Verifies That the Supplied Password Matches the Current User's Password. tags: - Account x-cli-name: accounts:password-check /account/ssh-keys: get: description: 'Gets a list of SSH keys associated with the current user. Filterable fields: * `label` Sortable fields: * `label` ' operationId: getAccountSshKeys 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: - _links: self: href: https://cloud.acquia.com/api/account/ssh-keys/02905393-65d7-4bef-873b-24593f73d273 created_at: '2017-05-09T20:30:35+00:00' fingerprint: 5d:23:fb:45:70:df:ef:ad:ca:bf:81:93:cd:50:26:28 label: PC Home public_key: ssh-rsa AAAAB3NzaC1yc2EADHrfHY17SbrmAAABIwAAAQEAklOUpkTIpNLTGK9Tjom/BWDSUGPl+nafzlZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5HDTYW7hdI4yQVkbPppSwg0cda3Pbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com uuid: 02905393-65d7-4bef-873b-24593f73d273 - _links: self: href: https://cloud.acquia.com/api/account/ssh-keys/d40833b3-6ea4-4339-9e2c-4b78e700258b created_at: '2017-05-09T20:30:35+00:00' fingerprint: 5b:18:fb:50:55:df:cf:d5:bf:ea:81:23:ef:55:22:29 label: Laptop Work public_key: ssh-rsa 1yc2EAAAABIwbrmTIpNLTGK9Tjom/BWDSUGPl+nafzlHDAAAQEAklOUpkDHrfHY17STYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4pSwg0cda3PbAAAAB3NzaCv7kOdJ/MTyBlWXFCRh9lFX5QVkbPp+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com uuid: d40833b3-6ea4-4339-9e2c-4b78e700258b - _links: self: href: https://cloud.acquia.com/api/account/ssh-keys/c40ee264-0023-4f60-815b-d20b44740746 created_at: '2017-05-09T20:30:35+00:00' fingerprint: 7c:s3:ab:30:40:da:cf:c5:bf:ca:31:33:ed:58:23:21 label: PC Work public_key: ssh-rsa A1yc2EAAAlOUpkDHrfHY17SbrmTIAAAB3NzaCom/BWDSUGPl+nafzlHDTYW7hdI4yQVkbPppSwg0cda3ABIwAAAQEAkPZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5bv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com uuid: c40ee264-0023-4f60-815b-d20b44740746 _links: filter: href: https://cloud.acquia.com/api/account/ssh-keys{?filter} templated: true limit: href: https://cloud.acquia.com/api/account/ssh-keys{?limit} templated: true parent: href: https://cloud.acquia.com/api/account self: href: https://cloud.acquia.com/api/account/ssh-keys sort: href: https://cloud.acquia.com/api/account/ssh-keys{?sort} templated: true total: 3 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-keys' description: OK '404': content: application/hal+json: examples: User not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Gets a List of SSH Keys Associated with the Current User. tags: - Account x-cli-name: accounts:ssh-keys-list post: description: Installs a new SSH key for the current user. operationId: postAccountSshKeys requestBody: content: application/hal+json: example: label: mykey public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-key-request' application/x-www-form-urlencoded: example: label: mykey public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-key-request' required: true responses: '202': content: application/hal+json: example: _links: notification: href: https://cloud.acquia.com/api/notifications/5fef247f-3c99-42a2-bb3c-69b32a06e7e9 parent: href: https://cloud.acquia.com/api/account self: href: https://cloud.acquia.com/api/account/ssh-keys message: Adding SSH key. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links' description: Accepted '400': content: application/hal+json: examples: Label is invalid: value: error: validation_failed message: public_key: 'The supplied label is invalid: it may only contain letters, numbers and underscores.' Public key is invalid: value: error: validation_failed message: public_key: The supplied public key is invalid. Public key must be RSA: value: error: validation_failed message: public_key: 'The supplied public key type is unsupported: it must be RSA (ssh-rsa).' Public key too short: value: error: validation_failed message: public_key: 'The supplied public key type is too short: it must be at least 4096 bits long.' schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error' description: Bad Request '404': content: application/hal+json: examples: Not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Key with label already exists: value: error: conflict message: An SSH key with this label already exists for this user. Key with public key already exists: value: error: conflict message: An SSH key with this public key already exists for this user. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Installs a New SSH Key for the Current User. tags: - Account x-cli-name: accounts:ssh-key-create /account/ssh-keys/{sshKeyUuid}: delete: description: Deletes an SSH key. operationId: deleteAccountSshKey parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_ssh-key-uuid' responses: '202': content: application/hal+json: examples: Removed key: value: _links: notification: href: https://cloud.acquia.com/api/notifications/519caf5f-007a-4562-a726-37624cff7fd8 parent: href: https://cloud.acquia.com/api/account/ssh-keys self: href: https://cloud.acquia.com/api/account/ssh-keys/1acbb1a5-e864-4b8e-a3f9-b1ed462afd25 message: Removed SSH key. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links' description: Accepted '404': content: application/hal+json: examples: SSH key does not exist: value: error: not_found message: An SSH key with UUID 1df4cb00-2fe9-11e9-b210-d663bd873d93 does not exist. SSH key missing: value: error: not_found message: The SSH key does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Deletes an SSH Key. tags: - Account x-cli-name: accounts:ssh-key-delete get: description: Get an SSH key associated with the currently-logged in user. operationId: getAccountSshKey parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_ssh-key-uuid' responses: '200': content: application/hal+json: example: _links: parent: href: https://cloud.acquia.com/api/account/ssh-keys self: href: https://cloud.acquia.com/api/account/ssh-keys/b2a53dfb-f4e2-4543-814d-7a9aa3793746 created_at: '2017-05-09T20:30:35+00:00' fingerprint: 8d:13:fb:50:50:da:cf:c5:bf:ca:31:33:ed:51:27:24 label: PC Home public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com uuid: b2a53dfb-f4e2-4543-814d-7a9aa3793746 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ssh-key' description: OK '404': content: application/hal+json: examples: SSH key missing: value: error: not_found message: The SSH key does not exist, or you do not have permission to access it. SSH key not found: value: error: not_found message: The SSH key 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 Get an SSH Key Associated with the Currently-logged in User. tags: - Account x-cli-name: accounts:ssh-key-find /account/subscriptions/{subscriptionUuid}/is-admin: get: description: Returns whether your account is an administrator for a subscription. operationId: getAccountSubscriptionIsAdministrator parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid' responses: '200': content: application/hal+json: example: _links: self: href: https://cloud.acquia.com/api/account/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93/is-admin subscription: href: https://cloud.acquia.com/api/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93 admin: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-administrator' description: OK '403': content: application/hal+json: examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this subscription. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Not found: value: error: not_found message: The 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 Whether Your Account is an Administrator for a Subscription. tags: - Account x-cli-name: accounts:is-subscription-admin /account/subscriptions/{subscriptionUuid}/is-owner: get: description: Returns whether your account is the owner for a subscription. operationId: getAccountSubscriptionIsOwner parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid' responses: '200': content: application/hal+json: example: _links: self: href: https://cloud.acquia.com/api/account/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93/is-owner subscription: href: https://cloud.acquia.com/api/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93 owner: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-owner' 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 security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Returns Whether Your Account is the Owner for a Subscription. tags: - Account x-cli-name: accounts:is-subscription-owner /account/teams/{teamUuid}/has-permission: get: description: Returns whether your account has access to a specific team permission. operationId: getAccountTeamHasPermission parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_permission' responses: '200': content: application/hal+json: example: _links: self: href: https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod team: href: https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93 access: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_has-permission' description: OK '403': content: application/hal+json: examples: Do not have permission: value: error: forbidden message: You do not have the 'example permission' permission for this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Permission not found: value: error: not_found message: The permission you are trying to look up does not exist. Team not found: value: error: not_found message: The team 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 Whether Your Account Has Access to a Specific Team Permission. tags: - Account x-cli-name: accounts:has-team-permission /account/teams/{teamUuid}/is-admin: get: description: Returns whether your account is an administrator for a team. operationId: getAccountTeamIsAdministrator parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' responses: '200': content: application/hal+json: example: _links: self: href: https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/is-admin team: href: https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93 admin: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-administrator' description: OK '403': content: application/hal+json: examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Not found: value: error: not_found message: The team 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 Whether Your Account is an Administrator for a Team. tags: - Account x-cli-name: accounts:is-team-admin /account/teams/{teamUuid}/is-owner: get: description: Returns whether your account is the owner for a team. operationId: getAccountTeamIsOwner parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' responses: '200': content: application/hal+json: example: _links: self: href: https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/is-owner team: href: https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93 owner: true schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-owner' description: OK '404': content: application/hal+json: examples: Not found: value: error: not_found message: The team 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 Whether Your Account is the Owner for a Team. tags: - Account x-cli-name: accounts:is-team-owner /account/tokens: get: description: Returns a list of metadata for API access tokens tied to your account. operationId: getAccountTokens responses: '200': content: application/hal+json: example: _embedded: items: - _links: self: href: https://cloud.acquia.com/api/account/tokens/17feaf34-5d04-402b-9a67-15d5161d24e1 active: true created_at: 2016-01-22T17:41:57-0500 flags: active: true label: My First App revocation: null uuid: 17feaf34-5d04-402b-9a67-15d5161d24e1 - _links: self: href: https://cloud.acquia.com/api/account/tokens/81e8965d-0af0-460d-9e46-977dfcc38c29 active: true created_at: 2016-01-22T17:55:15-0500 flags: active: true label: My Second App revocation: null uuid: 81e8965d-0af0-460d-9e46-977dfcc38c29 _links: parent: href: https://cloud.acquia.com/api/account self: href: https://cloud.acquia.com/api/account/tokens total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_tokens' description: OK '404': content: application/hal+json: examples: User not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Returns a List of Metadata for API Access Tokens Tied to Your Account. tags: - Account x-cli-name: accounts:tokens-list post: description: Creates an API access token tied to your account. operationId: postAccountTokens requestBody: content: application/hal+json: example: label: API token for My App schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token-request' application/x-www-form-urlencoded: example: label: API token for My App schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token-request' required: true responses: '201': content: application/hal+json: example: _links: notification: href: https://cloud.acquia.com/api/notifications/ab142771-826e-42b0-a53c-e112b70448d2 parent: href: https://cloud.acquia.com/api/account self: href: https://cloud.acquia.com/api/account/tokens api_key: 137bd484-dcc8-4950-a784-1f01de7f6378 api_secret: 4DmbUmGiUkafdjcZk2yV6u17jPmmunwt8/47mKdAQIc= client_id: 137bd484-dcc8-4950-a784-1f01de7f6378 client_secret: 4DmbUmGiUkafdjcZk2yV6u17jPmmunwt8/47mKdAQIc= schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token-creation' description: Created '404': content: application/hal+json: examples: Not found: value: error: not_found message: The user does not exist, or you do not have access to it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Creates an API Access Token Tied to Your Account. tags: - Account x-cli-name: accounts:token-create /account/tokens/{tokenUuid}: delete: description: Revokes an access token. This action will prevent the access token from being able to authorize access to the API in the future. operationId: deleteAccountToken parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-delete-reason' responses: '200': content: application/hal+json: example: _links: notification: href: https://cloud.acquia.com/api/notifications/7815f68b-fc52-4dc8-bdde-04d0960943e9 parent: href: https://cloud.acquia.com/api/account/tokens self: href: https://cloud.acquia.com/api/account/tokens/03c86402-5e3b-4212-b6fd-009d271da1d0 message: The access token has been revoked. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links' description: OK '404': content: application/hal+json: examples: Not found: value: error: not_found message: The access token does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Already revoked: value: error: conflict message: The access token has already been revoked. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Revokes an Access Token. tags: - Account x-cli-name: accounts:token-delete get: description: Return details about a specific token. operationId: getAccountToken parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-uuid' responses: '200': content: application/hal+json: example: _links: parent: href: https://cloud.acquia.com/api/account/tokens self: href: https://cloud.acquia.com/api/account/tokens/17feaf34-5d04-402b-9a67-15d5161d24e1 active: true created_at: 2016-01-22T17:41:57-0500 flags: active: true label: My App v1.0 revocation: null uuid: 17feaf34-5d04-402b-9a67-15d5161d24e1 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_token' description: OK '404': content: application/hal+json: examples: Token not found: value: error: not_found message: The access token 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 Token. tags: - Account x-cli-name: accounts:token-list servers: [] tags: - name: Account