openapi: 3.0.0
info:
contact:
name: Customer Experience Engineering (CXE)
url: https://www.acquia.com
description: "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one week notice\n * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one month notice\n * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n application/hal+json\n {\n \"error\": \"system\",\n \"message\": \"This action is currently unavailable. Please try again later.\"\n }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: 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 Applications API
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
servers: []
tags:
- name: Applications
paths:
/applications:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Applications contains the code, files, and databases required to run sites. You have access to an application if you are a member of a team that has access to an application, or if you are an administrator or owner of the organization that the application belongs to. A subscription may contain one or more applications.
Filterable fields:
* `label`
* `name` (Deprecated)
* `organization_name`
* `hosting` (Deprecated) Use URL encoded colon (%3A) to separate realm and sitegroup, e.g. network%3An3 instead of network:n3
Sortable fields:
* `label`
* `name` (Deprecated)
* `organization_name`
'
operationId: getApplications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 241643
name: Sample application 1
organization:
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
status: normal
subscription:
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471
flags:
remote_admin: false
hosting:
id: devcloud:devcloud2
type: free
id: 954291
name: Sample application 2
organization:
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
status: provisioning
subscription:
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: node
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
_links:
filter:
href: https://cloud.acquia.com/api/applications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/
self:
href: https://cloud.acquia.com/api/applications?limit=10
sort:
href: https://cloud.acquia.com/api/applications{?sort}
templated: true
pagination:
limit: 10
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications'
description: OK
'403':
content:
application/hal+json:
examples:
Not found:
value:
error: forbidden
message: You do not have permission to view applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return a List of Applications the Current User Has Access To.
tags:
- Applications
x-cli-name: applications:list
/applications/{applicationUuid}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: A specific application.
operationId: getApplicationByUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
organization:
_links:
self:
href: https://cloud.acquia.com/api/organizations/6a907396-abfd-4d01-9da6-64c8efc04519
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
subscription:
_links:
self:
href: https://cloud.acquia.com/api/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d470
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
_links:
code:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/code
databases:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases
environments:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/environments
events:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/events
features:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/features
ides:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/ides
parent:
href: https://cloud.acquia.com/api/applications
permissions:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/permissions
search:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/search
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
settings:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings
tasks:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks
teams:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/teams
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 2416431
name: Sample application
organization:
name: Sample organization
uuid: 6a907396-abfd-4d01-9da6-64c8efc04519
status: normal
subscription:
name: Sample subscription
uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application'
description: OK
'404':
content:
application/hal+json:
example:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Details About a Specific Application.
tags:
- Applications
x-cli-name: applications:find
put:
description: Renames a specific application.
operationId: putApplicationByUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
name: My new application name
schema:
properties:
name:
description: The new name of the application.
maxLength: 255
minLength: 1
type: string
type: object
application/x-www-form-urlencoded:
example:
name: My new application name
schema:
properties:
name:
description: The new name of the application.
type: string
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/27698331-bcf9-48e9-9f12-931ac88f446f
parent:
href: https://cloud.acquia.com/api/applications
self:
href: https://cloud.acquia.com/api/applications/db1d0e46-6799-4208-9786-c7e64150a7c7
message: Application renamed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'400':
content:
application/hal+json:
examples:
Name already in use:
value:
error: validation_failed
message:
name: You already have an application with this name.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to modify this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application:
value:
error: not_found
message: The application with UUID a47ac10b-58cc-4372-a567-0e02b2c3d470 does not exist.
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Name in use:
value:
error: conflict
message: The new application name is the same as the old application name. No action taken.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Renames an Application.
tags:
- Applications
x-cli-name: applications:rename
/applications/{applicationUuid}/artifacts:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of this application''s build artifacts. Only available for Node.js applications.
Filterable fields:
* `created`
* `name`
Sortable fields:
* `created`
* `name`
'
operationId: getArtifactsByApplicationUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1
created_at: '2012-05-15T12:00:00Z'
id: 1
name: master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2
state: ready
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/2
created_at: '2012-05-15T12:00:00Z'
id: 2
name: master@a265389db6a6918cf4e51edbe5f06d7e1578175c
state: pending-upload
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/3
created_at: '2012-05-15T12:00:00Z'
id: 3
name: master@e7157f36e5fb82317ffee2fc2d70302cdad0c60c
state: deleted
_links:
filter:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts
sort:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifacts'
description: OK
'404':
content:
application/hal+json:
examples:
Application type:
value:
error: not_found
message: Artifacts are only available for Node.js applications.
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Application Artifacts.
tags:
- Applications
x-cli-name: applications:artifact-list
/applications/{applicationUuid}/artifacts/{artifactId}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'A specific artifact.
'
operationId: getArtifactByApplicationUuidAndId
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_artifact-id'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1
created_at: '2012-05-15T12:00:00Z'
id: 1
name: master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2
state: ready
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact'
description: OK
'404':
content:
application/hal+json:
examples:
Application type:
value:
error: not_found
message: Artifacts are only available for Node.js applications.
No application:
value:
error: not_found
message: The application with UUID a47ac10b-58cc-4372-a567-0e02b2c3d470 does not exist.
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
No artifact:
value:
error: not_found
message: The build artifact you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Return Details About a Specific Artifact.
tags:
- Applications
x-cli-name: applications:artifact-find
/applications/{applicationUuid}/code:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of branches and release (repository) tags in this application''s version control system.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getCodeByApplicationUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- flags:
tag: false
name: master
- flags:
tag: false
name: feature-branch
- flags:
tag: true
name: tags/2014-09-03
- flags:
tag: true
name: tags/2014-09-03.0
_links:
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/code
total: 4
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code'
description: OK
'404':
content:
application/hal+json:
examples:
No VCS Settings:
value:
error: not_found
message: No version control system settings found on non-hosted application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Application Branches and Release Tags.
tags:
- Applications
x-cli-name: applications:vcs-info
/applications/{applicationUuid}/code-studio:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
delete:
description: Removes the Code Studio project from an application.
operationId: deleteCodeStudioProject
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/e0c0ec4d-cb4d-4b9a-92ed-503d1e8dae4a
self:
href: https://cloud.acquia.com/api/applications/98529a07-5f07-4c4d-836b-03c9226c03fd/code-studio
message: The Code Studio project is being removed from the Application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to remove the Code Studio project from this Application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes the Code Studio Project from an Application.
tags:
- Applications
get:
description: Return details about the Code Studio project for an application.
operationId: getCodeStudioProject
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
application:
_links:
self:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c
name: My Application
uuid: 906c1ad5-f367-4127-b529-9dbe29bc5c1c
_links:
application:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c
applications:
href: https://cloud.acquia.com/api/applications
code-studio:
href: https://code.acquia.com/path/to/project
code-studio-api:
href: https://code.acquia.com/api/v4/path/to/project
parent:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c
self:
href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c/code-studio
application_id: 906c1ad5-f367-4127-b529-9dbe29bc5c1c
status: active
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-studio-project'
description: OK
'403':
content:
application/hal+json:
examples:
No entitlement:
value:
error: forbidden
message: Code Studio is not available for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Code Studio not enabled for application:
value:
error: not_found
message: Code Studio is not enabled for this application.
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Details About the Code Studio Project for an Application.
tags:
- Applications
post:
description: Creates the Code Studio project for an application.
operationId: postCodeStudioProject
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/e0c0ec4d-cb4d-4b9a-92ed-503d1e8dae4a
self:
href: https://cloud.acquia.com/api/applications/98529a07-5f07-4c4d-836b-03c9226c03fd/code-studio
message: A Code Studio project is being created for the Application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to create a Code Studio project for this Application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates the Code Studio Project for an Application.
tags:
- Applications
/applications/{applicationUuid}/databases:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getApplicationDatabases
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- name: database1
- name: database2
_links:
filter:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases
sort:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-databases'
description: OK
'404':
content:
application/hal+json:
examples:
No data or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
Non-hosted application:
value:
error: not_found
message: Databases do not exist on non-hosted applications.
Not available on Node.js:
value:
error: not_found
message: Databases do not exist on Node.js applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List Database Names for the Application.
tags:
- Applications
x-cli-name: applications:database-list
post:
description: This action will create a new database within each environment of the application.
operationId: postApplicationDatabaseCreate
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
name: my_db_name
schema:
description: Application database name.
properties:
name:
description: The database name.
maxLength: 63
minLength: 1
type: string
required:
- name
type: object
application/x-www-form-urlencoded:
example:
name: my_db_name
schema:
description: Application database name.
properties:
name:
description: The database name.
maxLength: 63
minLength: 1
type: string
required:
- name
type: object
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69
parent:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1
self:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases
message: The database is being created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Missing parameter:
value:
error: validation_failed
message:
name: 'Missing required parameter(s): example_param'
Name already in use:
value:
error: validation_failed
message:
name: A database with that name already exists. Please choose another name.
Name can only be alphanumeric and underscores:
value:
error: validation_failed
message:
name: The database name can only contain alphanumeric characters and underscores.
Name cannot be default:
value:
error: validation_failed
message:
name: The database name cannot be "default".
Name cannot exceed 63 characters in length:
value:
error: validation_failed
message:
general: The database name cannot exceed 63 characters in length.
Not available on Site Factory applications:
value:
error: validation_failed
message:
general: Databases cannot be added on Acquia Cloud Site Factory applications.
Only available for hosted applications:
value:
error: validation_failed
message:
general: Databases can only be added on Acquia-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
ACSF application:
value:
error: forbidden
message: Databases cannot be added to Acquia Cloud Site Factory applications.
No permission:
value:
error: forbidden
message: You do not have permission to add a database to this application.
Node.js application:
value:
error: forbidden
message: Databases cannot be added on Node.js applications.
Non-hosted application:
value:
error: forbidden
message: Databases cannot be added to non-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a Database.
tags:
- Applications
x-cli-name: applications:database-create
/applications/{applicationUuid}/databases/{name}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
delete:
description: This action will delete the database in ALL environments within this application.
operationId: postApplicationDatabaseDelete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_name'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3
parent:
href: https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases
self:
href: https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases/testdatabase
message: The database is being deleted.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Can only be erased on free tier applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia Free Tier applications.
Can only be erased on hosted applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia-hosted applications.
Cannot delete default:
value:
error: validation_failed
message:
name: The database is a default database, and cannot be removed.
Does not belong to application:
value:
error: validation_failed
message:
name: The database does not belong to this application, and cannot be removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
ACSF application:
value:
error: forbidden
message: Databases cannot be deleted on Acquia Cloud Site Factory applications.
No permission:
value:
error: forbidden
message: You do not have permission to delete this database.
Node.js application:
value:
error: forbidden
message: Databases cannot be erased on Node.js applications.
Non hosted application:
value:
error: forbidden
message: Databases cannot be deleted on non-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Drops (deletes) a Database.
tags:
- Applications
x-cli-name: applications:database-delete
/applications/{applicationUuid}/databases/{name}/actions/erase:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: This action will delete all tables of the database in ALL environments within this application.
operationId: postApplicationDatabaseErase
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_name'
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3
parent:
href: https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions
self:
href: https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions/erase
message: The database is being erased.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Can only be erased on free tier applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia Free Tier applications.
Can only be erased on hosted applications:
value:
error: validation_failed
message:
general: Databases can only be erased on Acquia-hosted applications.
Does not belong to application:
value:
error: validation_failed
message:
name: The database does not belong to this application, and cannot be removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
ACF only:
value:
error: forbidden
message: Only Acquia Cloud Free subscriptions can erase databases.
No permission:
value:
error: forbidden
message: You do not have permission to erase this database.
Node.js application:
value:
error: forbidden
message: Databases cannot be erased on Node.js applications.
Non-hosted application:
value:
error: forbidden
message: Databases cannot be erased on non-hosted applications.
Service Management-enabled application:
value:
error: forbidden
message: Databases cannot be erased on Service Management-enabled applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Erases (truncates) a Database.
tags:
- Applications
x-cli-name: applications:database-erase
/applications/{applicationUuid}/email/domains:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of email domains associated with the application and domains that have been verified at the subscription level.
operationId: getApplicationEmailDomains
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- domain_name: example.com
flags:
associated: true
health:
code: '200'
details: ''
summary: OK
uuid: 123e4567-e89b-12d3-a456-426614174000
- domain_name: example2.com
flags:
associated: true
health:
code: '200'
details: ''
summary: OK
uuid: 123e4567-e89b-12d3-a456-426614174000
_links:
filter:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications123e4567-e89b-12d3-a456-426614174000/email/domains{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email
self:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains
sort:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?sort}
templated: true
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email-domains'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to manage email domains for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No data or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Email Domains Associated with the Application.
tags:
- Applications
x-cli-name: applications:email-domains-list
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Associates an email domain with an Application.
operationId: postApplicationAssociateEmailDomain
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Associate Domain:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000
self:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000/actions/associate
message: The domain has been associated with the application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to associate domains with this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to associate a domain registration with does not exist or you do not have permission to access it.
Domain not found:
value:
error: not_found
message: The domain registration you are trying to associate does not exist or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Already associated:
value:
error: conflict
message: The domain example.com is already associated with this application.
No entitlement:
value:
error: conflict
message: Platform Email is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Associates an Email Domain with an Application.
tags:
- Applications
x-cli-name: applications:post-associate-email-domain
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Disassociates an email domain with an Application.
operationId: postApplicationDisassociateEmailDomain
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Disassociate Domain:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000
parent:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000
self:
href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/dissasociate
message: The domain has been disassociated from the application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to disassociate domains from this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to disassociate a domain registration from does not exist or you do not have permission to access it.
Domain not found:
value:
error: not_found
message: The domain registration you are trying to disassociate does not exist or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Domain minimum:
value:
error: conflict
message: The application must have at least one associated domain while Platform Email is enabled on an environment.
No entitlement:
value:
error: conflict
message: Platform Email is not available for this subscription.
Not associated:
value:
error: conflict
message: The domain example.com is not associated with this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Disassociates an Email Domain with an Application.
tags:
- Applications
x-cli-name: applications:post-disassociate-email-domains
/applications/{applicationUuid}/environments:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of environments within this application.
operationId: getApplicationEnvironments
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470
active_domain: example.com
application:
name: Sample Drupal application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact: null
balancer: balancers
configuration:
operating_system: precise
php:
apcu: 32
client_max_body_size: 128
interned_strings_buffer: 16
max_execution_time: 300
max_input_vars: 1000
max_post_size: 256
memcached_limit: 64
memory_limit: 128
opcache: 96
upload_max_filesize: 256
version: '8.3'
default_domain: sitedev.hosted.acquia-sites.com
domains:
- sitedev.hosted.acquia-sites.com
- example.com
flags:
cde: false
cdn: false
email: false
hsd: false
livedev: false
multi_region: false
multicert: false
production: false
production_mode: false
remote_admin: false
varnish: true
varnish_over_ssl: false
id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470
image_url: null
ips:
- 10.0.1.5
label: Dev
name: dev
platform: cloud
region: us-east-1
size: medium
ssh_url: site.dev@sitedev.ssh.hosted.acquia-sites.com
status: normal
type: drupal
vcs:
path: master
type: git
url: site@svn-3.hosted.acquia-sites.com:site.git
weight: 0
- _links:
self:
href: https://cloud.acquia.com/api/environments/15-a47ac10b-58cc-4372-a567-0e02b2c3d470
active_domain: example.com
application:
name: Sample SiteFactory application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact: null
balancer: balancers
configuration: null
default_domain: siteprod.hosted.acquia-sites.com
domains:
- siteprod.hosted.acquia-sites.com
- example.com
flags:
cde: false
cdn: false
email: false
hsd: false
livedev: false
multi_region: false
multicert: false
production: true
production_mode: true
remote_admin: false
varnish: true
varnish_over_ssl: false
gardener:
multi-site: prod.example.com/admin/gardens/staging
site-update: prod.example.com/admin/gardens/site-update
id: 15-a47ac10b-58cc-4372-a567-0e02b2c3d470
image_url: null
ips:
- 10.0.1.1
- 10.0.1.2
label: Production
name: prod
platform: cloud
region: us-east-1
size: medium
ssh_url: site.prod@siteprod.ssh.hosted.acquia-sites.com
status: normal
type: drupal
vcs:
path: tags/01-01-2015
type: git
url: site@svn-3.hosted.acquia-sites.com:site.git
weight: 0
- _links:
self:
href: https://cloud.acquia.com/api/environments/32-a47ac10b-58cc-4372-a567-0e02b2c3d470
active_domain: test.example.com
application:
name: Sample Node application
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
artifact:
id: 1
name: Example artifact
balancer: balancers
configuration:
node:
version: 6.11.1
operating_system: precise
default_domain: sitetest.hosted.acquia-sites.com
domains:
- sitetest.hosted.acquia-sites.com
- test.example.com
flags:
cde: false
cdn: false
email: false
hsd: false
livedev: false
multi_region: false
multicert: false
production: false
production_mode: false
remote_admin: false
varnish: true
varnish_over_ssl: false
id: 32-a47ac10b-58cc-4372-a567-0e02b2c3d470
image_url: null
ips: []
label: Stage
name: test
platform: cloud
region: us-east-1
size: medium
ssh_url: site.test@sitetest.ssh.hosted.acquia-sites.com
status: normal
type: node
vcs:
path: null
type: git
url: qa10@svn-3.networkdev.ahserversdev.com:qa10.git
weight: 20
_links:
filter:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments
sort:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environments'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: No environments exist on non-hosted applications.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns a List of Environments Within This Application by its UUID.
tags:
- Applications
x-cli-name: applications:environment-list
post:
description: Add a new continuous delivery environment.
operationId: postApplicationEnvironments
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
branch: my-feature-branch
databases:
- database1
- database2
label: CD label
schema:
properties:
branch:
description: The name of the branch or tag that the continuous delivery environment will have.
type: string
databases:
description: An array containing the names of the databases to add to the continuous delivery environment.
items:
type: string
type: array
label:
description: The new environment label.
type: string
required:
- label
- branch
- databases
type: object
application/x-www-form-urlencoded:
schema:
example:
branch: my-feature-branch
databases:
- database1
- database2
label: CD label
properties:
branch:
description: The name of the branch or tag that the continuous delivery environment will have.
type: string
databases:
description: The names of the databases to add to the continuous delivery environment.
items:
type: string
type: array
label:
description: The new environment label.
type: string
required:
- label
- branch
- databases
type: object
required: true
responses:
'202':
content:
application/hal+json:
examples:
Adding environment:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/23d9184d-40b8-4f21-a3d5-416aef9bcd39
parent:
href: https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments
self:
href: https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments
message: Adding an environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Application does not support CD environments:
value:
error: validation_failed
message:
general: This application does not support CD environments.
Application is at capacity:
value:
error: validation_failed
message:
general: This application already has the maximum number of CD environments.
Application is not hosted by Acquia:
value:
error: validation_failed
message:
general: Environments can only be added on Acquia-hosted applications.
Databases do not exist:
value:
error: validation_failed
message:
general: One or more of the databases you have specified do not exist in this application.
Label already exists:
value:
error: validation_failed
message:
label: Another environment within this application already has this label.
Missing parameter:
value:
error: validation_failed
message:
name: 'Missing required parameter(s): example_param'
Too many databases exist:
value:
error: validation_failed
message:
general: You cannot provision more than 3 databases on your new environment.
Too many databases provided:
value:
error: validation_failed
message:
general: Please specify 3 or fewer databases to provision on your environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Application is not hosted by Acquia:
value:
error: forbidden
message: CD environments cannot be added to non-hosted applications.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to add an environment.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Add a New Continuous Delivery Environment to an Application by the Application UUID.
tags:
- Applications
x-cli-name: applications:environment-create
/applications/{applicationUuid}/features:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of feature flags for this application.
'
operationId: getApplicationFeatures
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- description: Allows access to Some feature.
label: Some feature.
name: feature-name
- description: Allows access to Example feature.
label: Example feature.
name: example-feature
_links:
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/features
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-features'
description: OK
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Return Application Features.
tags:
- Applications
x-cli-name: applications:feature-list
/applications/{applicationUuid}/ides:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of Cloud IDEs associated with this application.
operationId: getApplicationIdes
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _embedded:
owner:
created_at: '2016-08-14T17:38:59-04:00'
email: user.name@example.com
first_name: First
last_login_at: '2019-01-31T10:53:11-05:00'
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
_links:
application:
href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199
ide:
href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ides.acquia.com
self:
href: https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7
web:
href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud
label: IDE Label 1
status: active
uuid: 9a83c081-ef78-4dbd-8852-11cc3eb248f7
- _embedded:
owner:
created_at: '2016-08-14T17:38:59-04:00'
email: user.name@example.com
first_name: First
last_login_at: '2019-01-31T10:53:11-05:00'
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
_links:
application:
href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199
ide:
href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ides.acquia.com
self:
href: https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8
web:
href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud
label: IDE Label 2
status: active
uuid: feea197a-9503-4441-9f49-b4d420b0ecf8
_links:
parent:
href: https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8
self:
href: https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8/ides
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ides'
description: OK
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Cloud IDEs Associated with This Application.
tags:
- Applications
x-cli-name: applications:ide-list
post:
description: Creates a new Cloud IDE.
operationId: postApplicationsIde
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
label: My new IDE
schema:
properties:
label:
description: The label of the Cloud IDE.
maxLength: 255
minLength: 1
type: string
required:
- label
type: object
application/x-www-form-urlencoded:
example:
label: My new IDE
schema:
properties:
label:
description: The label of the Cloud IDE.
maxLength: 255
minLength: 1
type: string
required:
- label
type: object
required: true
responses:
'202':
content:
application/hal+json:
examples:
IDE created:
value:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/e47da6d7-371e-4bb9-a7fe-d9ab8aa899c3
parent:
href: https://cloud.acquia.com/api/ides
self:
href: https://cloud.acquia.com/api/ides/1792767d-1ee3-4b5f-83a8-334dfdc2b8a3
message: The Cloud IDE is being created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'400':
content:
application/hal+json:
examples:
Bad IDE label:
value:
error: validation_error
message:
name: A Cloud IDE labeled My new IDE already exists.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'404':
content:
application/hal+json:
examples:
No user:
value:
error: not_found
message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a New Cloud IDE.
tags:
- Applications
x-cli-name: ide:create
/applications/{applicationUuid}/messages:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `title`
* `message_type`
* `display_mode`
Sortable fields:
* `title`
* `message_type`
* `display_mode`
'
operationId: getApplicationMessages
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
dismiss:
href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/dismiss
follow:
href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/follow
self:
href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623
body: This is the body of the IPM.
expire_at: '2015-12-05T13:30:00-05:00'
filters:
display_mode: bar
paths:
- /some/random/path
- /other/random/path
type: general
flags:
active: true
dismissed: false
dismissible: true
id: 123
start_at: '2015-11-05T00:30:00-05:00'
title: IPM Title
url: http://www.acquia.com
uuid: 77fedb64-b8c0-4712-90e3-f39b4716e623
weight: -1
- _links:
dismiss:
href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/dismiss
follow:
href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/follow
self:
href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2
body: IPM Message 2 body
expire_at: '2016-11-07T17:30:00-05:00'
filters:
display_mode: bar
paths: []
type: new
flags:
active: true
dismissed: false
dismissible: true
id: 234
start_at: '2015-11-07T17:30:00-05:00'
title: IPM Message 2
url: http://www.google.ca
uuid: c5328e00-282a-4bec-a3c8-4322d97545b2
weight: 0
_links:
filter:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?limit}
templated: true
self:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages
sort:
href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-messages'
description: OK
'404':
content:
application/hal+json:
examples:
No application or permission:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Messages Associated with This Application.
tags:
- Applications
x-cli-name: applications:message-list
/applications/{applicationUuid}/metrics/usage:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Retrieves traversal links for an application's usage data.
operationId: getApplicationsUsageLinks
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
data:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data
data-by-environment:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
views:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
views-by-environment:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment
visits:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
visits-by-environment:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_usage'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view usage metrics for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Traversal Links for Detailed Metrics on Usage (views and Visits) of Your Application.
tags:
- Applications
x-cli-name: applications:usage-links
/applications/{applicationUuid}/metrics/usage/data:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `metric` - One of: {`views`, `visits`}
* `environment`
'
operationId: getApplicationsUsageData
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '9'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '3'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metrics'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view usage metrics for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Aggregate Usage Data for an Application, Filterable by Views or Visits and by Environment.
tags:
- Applications
x-cli-name: applications:usage-data
/applications/{applicationUuid}/metrics/usage/data-by-environment:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `metric` - One of: {`views`, `visits`}
* `environment`
'
operationId: getApplicationsUsageDataByEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
- _links:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '9'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '3'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment
pagination:
limit: 6
offset: 0
total: 6
total: 6
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metrics'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view usage metrics for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Usage Data (views or Visits) for an Application, Broken Down by Environment.
tags:
- Applications
x-cli-name: applications:usage-data-by-environment
/applications/{applicationUuid}/metrics/usage/views-by-environment:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `environment`
'
operationId: getApplicationsUsageViewsDataByEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '9'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment
pagination:
limit: 3
offset: 0
total: 3
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metrics'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view usage metrics for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Views Data for an Application, Broken Down by Environment.
tags:
- Applications
x-cli-name: applications:usage-views-data-by-environment
/applications/{applicationUuid}/metrics/usage/visits-by-environment:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `environment`
'
operationId: getApplicationsUsageVisitsDataByEnvironment
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
- _links:
parent:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '3'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
- _links:
parent:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits
datapoints: []
last_data_at: null
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: visits
_links:
filter:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment
pagination:
limit: 3
offset: 0
total: 3
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metrics'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view usage metrics for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Visits Data for an Application, Broken Down by Environment.
tags:
- Applications
x-cli-name: applications:usage-visits-data-by-environment
/applications/{applicationUuid}/metrics/usage/{usageMetric}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Filterable fields:
* `environment`
'
operationId: getApplicationsUsageMetricData
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_usage-metric'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage
self:
href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views
datapoints:
- - '2019-03-13T00:00:00+00:00'
- '9'
- - '2019-03-14T00:00:00+00:00'
- '1'
last_data_at: '2019-03-14T00:00:00+00:00'
metadata:
application:
uuids:
- 1df8bff7-ffda-4571-b64a-f90f60f4dbf8
environment:
ids:
- 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
- 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8
subscription:
uuids:
- 9567a611-4cdd-4586-8b3f-f3980a87e471
metric: views
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metric'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view usage metrics for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Retrieves Aggregate Usage Metric Data (views or Visits) for an Application..
tags:
- Applications
x-cli-name: applications:usage-metric-data
/applications/{applicationUuid}/notifications:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of notifications associated with this application. A notification represents an item of work to be done, initiated by someone (typically the current user) associated with the application.
Filterable fields:
* `event`
* `label`
* `description`
* `status`
* `author`
* `created_at`
* `completed_at`
Sortable fields:
* `event`
* `label`
* `description`
* `status`
* `author`
* `created_at`
* `completed_at`
'
operationId: getApplicationNotifications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/notifications
self:
href: https://cloud.acquia.com/api/notifications/1bd3487e-71d1-4fca-a2d9-5f969b3d35c1
completed_at: '2019-07-29T20:47:13+00:00'
context:
application:
uuids:
- a027502b-ad6c-a48e-a7e8-aa0def7d25e1
author:
actual_uuid: 5391a8a9-d273-4f88-8114-7f884bbfe08b
uuid: 5391a8a9-d273-4f88-8114-7f884bbfe08b
user:
uuids:
- 5391a8a9-d273-4f88-8114-7f884bbfe08b
created_at: '2019-07-29T20:47:13+00:00'
description: '"Canary QA 11 - ACE" was added to your recent applications list.'
event: ApplicationAddedToRecents
label: Application added to recents list
progress: 100
status: completed
uuid: 1bd3487e-71d1-4fca-a2d9-5f969b3d35c1
_links:
filter:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1
self:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications
sort:
href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?sort}
templated: true
pagination:
limit: 1
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-notifications'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Notifications Associated with This Application by its UUID.
tags:
- Applications
x-cli-name: applications:notification-list
/applications/{applicationUuid}/permissions:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of permissions the user has for this application.
operationId: getApplicationPermissions
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- description: Grants the ability to enable or disable live development and non-production work.
flags:
deprecated: false
group_label: Workflow
label: Pull and deploy code, files, or databases to non-production environments
name: deploy to non-prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Deploy code, files, or databases to the production environment
name: deploy to prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Pull files or databases from the production environment
name: pull from prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files to non-production environments
name: move file to non-prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files to the production environment
name: move file to prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files from production environments
name: move file from prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Move files from non-production environments
name: move file from non-prod
- description: null
flags:
deprecated: true
group_label: Workflow
label: Clear Varnish cache for non-production environments
name: clear varnish on non-prod
- description: null
flags:
deprecated: true
group_label: Workflow
label: Clear Varnish cache for the production environment
name: clear varnish on prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Configure production environment
name: configure prod env
- description: null
flags:
deprecated: false
group_label: Workflow
label: Configure non-production environments
name: configure non-prod env
- description: null
flags:
deprecated: false
group_label: Workflow
label: Add an environment
name: add an environment
- description: null
flags:
deprecated: false
group_label: Workflow
label: Delete an environment
name: delete an environment
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove domains for non-production environments
name: administer domain non-prod
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove domains for the production environment
name: administer domain prod
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove SSL certificates for the production environment
name: administer ssl prod
- description: null
flags:
deprecated: false
group_label: Domains
label: Add or remove SSL certificates for the non-production environments
name: administer ssl non-prod
- description: null
flags:
deprecated: false
group_label: Server administration
label: Reboot server
name: reboot server
- description: Increasing the size of your server costs money.
flags:
deprecated: false
group_label: Server administration
label: Resize server
name: resize server
- description: null
flags:
deprecated: false
group_label: Server administration
label: Suspend server
name: suspend server
- description: null
flags:
deprecated: false
group_label: Server administration
label: Configure server
name: configure server
- description: null
flags:
deprecated: false
group_label: Logs
label: Download logs for non-production environments
name: download logs non-prod
- description: null
flags:
deprecated: false
group_label: Logs
label: Download logs for the production environment
name: download logs prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Add a database
name: add database
- description: null
flags:
deprecated: false
group_label: Databases
label: Remove a database
name: remove database
- description: null
flags:
deprecated: false
group_label: Databases
label: View database connection details (username, password, or hostname)
name: view database connection
- description: null
flags:
deprecated: false
group_label: Databases
label: Download database backups for non-production environments
name: download db backup non-prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Download database backups for the production environment
name: download db backup prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Create database backups for non-production environments
name: create db backup non-prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Create database backups for the production environment
name: create db backup prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Restore database backups for non-production environments
name: restore db backup non-prod
- description: null
flags:
deprecated: false
group_label: Databases
label: Restore database backups for the production environment
name: restore db backup prod
- description: Granting this permission will give any user with this role full permissions on this team.
flags:
deprecated: false
group_label: Administration
label: Add or remove a user of a team
name: administer team
- description: Grants the ability to use the API and bypass all other permissions via command line tools.
flags:
deprecated: false
group_label: Administration
label: Access the Cloud API
name: access cloud api
- description: null
flags:
deprecated: false
group_label: Cron
label: Modify cron tasks for non-production environments
name: administer cron non-prod
- description: null
flags:
deprecated: false
group_label: Cron
label: Modify cron tasks for the production environment
name: administer cron prod
- description: null
flags:
deprecated: false
group_label: Support
label: Create a support ticket
name: create support ticket
- description: null
flags:
deprecated: false
group_label: Support
label: View and edit any support tickets for a subscription
name: edit any support ticket
- description: null
flags:
deprecated: false
group_label: Build
label: View Build plans
name: view build plans
- description: null
flags:
deprecated: false
group_label: Build
label: Edit Build plans
name: edit build plans
- description: null
flags:
deprecated: false
group_label: Build
label: Run Build plans
name: run build plans
- description: null
flags:
deprecated: false
group_label: SSH keys
label: Add SSH key to git repository
name: add ssh key to git
- description: null
flags:
deprecated: false
group_label: SSH keys
label: Add SSH key to non-production environments
name: add ssh key to non-prod
- description: null
flags:
deprecated: false
group_label: SSH keys
label: Add SSH key to the production environment
name: add ssh key to prod
- description: This permission is only relevant if your subscription has remote administration.
flags:
deprecated: false
group_label: Administration
label: View Remote Administration
name: view remote administration
- description: This permission is only relevant if your subscription has remote administration.
flags:
deprecated: false
group_label: Administration
label: Edit Remote Administration
name: edit remote administration
- description: null
flags:
deprecated: false
group_label: Workflow
label: Clear caches for the production environment
name: clear caches on prod
- description: null
flags:
deprecated: false
group_label: Workflow
label: Clear caches for non-production environments
name: clear caches on non-prod
_links:
parent:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/permissions
flags:
administrator: false
total: 49
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-permissions'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Permissions the User Has for This Application by its UUID.
tags:
- Applications
x-cli-name: applications:permission-list
/applications/{applicationUuid}/search:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Does not return any data. Allows traversal to search entity endpoints.
operationId: getApplicationSearchList
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
config-sets:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_search'
description: OK
'403':
content:
application/hal+json:
examples:
Forbidden:
value:
error: forbidden
message: You do not have permission to manage search for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns a Traversal Endpoint for Search Entities for the Application.
tags:
- Applications
x-cli-name: applications:search:list
/applications/{applicationUuid}/search/config-sets:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: A collection of search configuration sets for an application.
operationId: getApplicationSearchConfigurationSets
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121
application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
flags:
custom: false
id: shared-1234567891011-121
label: example-0
status: active
- _links:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
flags:
custom: true
id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
label: example-1
status: pending
- _links:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn79
application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
flags:
custom: true
id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn79
label: example-2
status: pending
_links:
filter:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
sort:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?sort}
templated: true
pagination:
limit: 3
offset: 0
total: 3
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-sets'
description: OK
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to view search configuration sets for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
example:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns a Collection of Search Configuration Sets for an Application
tags:
- Applications
x-cli-name: applications:search:configuration-set-list
post:
description: Creates a search configuration set for an application.
operationId: postApplicationSearchConfigurationSets
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
multipart/form-data:
schema:
description: The archive file binary.
properties:
archive:
description: A binary file response
format: binary
type: string
required:
- archive
type: object
required: true
responses:
'202':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/05fb83f1-59dd-4079-b9f3-ce9243a126ed
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
message: The search configuration set is being created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'400':
content:
application/hal+json:
examples:
Error during file upload:
value:
error: validation_failed
message:
general: An error occurred during file upload.
File exceeds size limit:
value:
error: validation_failed
message:
general: The uploaded file size exceeds the 10MB limit.
Request missing uploaded file:
value:
error: validation_failed
message:
general: The request does not contain an uploaded file.
Uploaded file is not a zip file:
value:
error: validation_failed
message:
general: The uploaded file is not a zip file.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to create search configuration sets on this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
example:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
example:
error: conflict
message: Acquia Search is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a Search Configuration Set for an Application.
tags:
- Applications
x-cli-name: applications:search:configuration-set-create
/applications/{applicationUuid}/search/config-sets/{configurationSetId}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
delete:
description: Removes and deletes a specific search configuration set from an application.
operationId: deleteApplicationSearchConfigurationSet
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_configuration-set-id'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/41aaeac7-7ead-4f39-b74c-42493e4dc27b
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
message: The search configuration set has been deleted.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to delete search configuration sets for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or not enough permissions:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
No configuration set or not enough permissions:
value:
error: not_found
message: The search configuration set you are trying to access does not exist, or you do not have permission to access it.
Search configuration set not available:
value:
error: not_found
message: The configuration set is not available for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
example:
error: conflict
message: Acquia Search is not available for this subscription.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes and Deletes a Specific Search Configuration Set from an Application.
tags:
- Applications
x-cli-name: applications:search:configuration-set-delete
get:
description: A specific search configuration set.
operationId: getApplicationSearchConfigurationSet
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_configuration-set-id'
responses:
'200':
content:
application/hal+json:
example:
_links:
download:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download
parent:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets
self:
href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121
application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905
flags:
custom: false
health:
code: OK
details: No issues.
summary: Search index active
id: shared-1234567891011-121
label: example-0
status: active
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-set'
description: OK
'403':
content:
application/hal+json:
example:
error: forbidden
message: You do not have permission to view search configuration sets for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No application or not enough permissions:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
No configuration set or not enough permissions:
value:
error: not_found
message: The search configuration set you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns a Search Configuration Set for an Application
tags:
- Applications
x-cli-name: applications:search:configuration-set-find
/applications/{applicationUuid}/settings:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Does not return any data. Allows traversal to settings groups endpoints.
operationId: getApplicationSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
hosting:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting
keys:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys
parent:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470
ra:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra
security:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_settings'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Available Settings for This Application.
tags:
- Applications
x-cli-name: applications:settings-list
/applications/{applicationUuid}/settings/hosting:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
deprecated: true
description: Returns the hosting settings for this application.
operationId: getApplicationHostingSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting
hosting_id: master:site
type: ace
uuid: abcd1234-1111-2222-3333-0e02b2c3d470
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_hosting-settings'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: not_found
message: You do not have permission to access the hosting settings.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Hosting Settings for This Application.
tags:
- Applications
x-cli-name: applications:hosting-settings-list
/applications/{applicationUuid}/settings/keys:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
deprecated: true
description: Returns the legacy product keys for this application.
operationId: getApplicationLegacyProductKeysSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys
acquia_connector:
identifier: ABCD-12345
key: 12345678f5325ea35d63a6c3debcd225
cloud_api:
key: 123456787987a135e2c143601328cbf1
username: abcd1234-1111-2222-3333-0e02b2c3d470
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_legacy-product-keys-settings'
description: OK
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to access these product keys.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Legacy Product Keys for This Application.
tags:
- Applications
x-cli-name: applications:legacy-product-key-find
/applications/{applicationUuid}/settings/ra:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns the remote administration settings for this application.
operationId: getApplicationRemoteAdministrationSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra
application_uuid: abcd1234-1111-2222-3333-0e02b2c3d470
deploy_at: 2016-03-04T12:01:05-0500
deploy_environment: test
flags:
copy_database: true
copy_files: true
merge_tag: false
merge_branch: master
pause_until: 2016-03-04T12:01:05-0500
source_environment: prod
update_mode: full
update_type: core
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration-settings'
description: OK
'403':
content:
application/hal+json:
examples:
Does not have remote administration:
value:
error: forbidden
message: This application does not have remote administration.
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to view the remote administration settings for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Remote Administration Settings for This Application.
tags:
- Applications
x-cli-name: applications:ra-settings-find
put:
description: Modifies the remote administration settings for an application.
operationId: putApplicationRemoteAdministrationSettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
copy_database: true
copy_files: false
deploy_at: '2020-10-13 13:00:00'
deploy_environment: test
merge_branch: master
merge_tag: false
pause_until: '2021-10-10 13:00:00'
source_environment: prod
update_mode: update
update_type: core_contrib
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration'
application/x-www-form-urlencoded:
example:
copy_database: true
copy_files: false
deploy_at: '2020-10-13 13:00:00'
deploy_environment: test
merge_branch: master
merge_tag: false
pause_until: '2021-10-10 13:00:00'
source_environment: prod
update_mode: update
update_type: core_contrib
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_remote-administration'
required: true
responses:
'200':
content:
application/hal+json:
example:
message: The remote administration settings have been updated
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'400':
content:
application/hal+json:
examples:
Deploy environment does not belong to application:
value:
error: validation_failed
message:
deploy_environment: The deploy environment does not belong to this application.
Invalid deploy environment:
value:
error: validation_failed
message:
deploy_environment: The deploy environment is not valid.
Invalid remote administration mode:
value:
error: validation_failed
message:
update_mode: The remote administration mode 'something' is invalid. Must be one of 'update', 'inform', or 'none'.
Invalid remote administration update type:
value:
error: validation_failed
message:
update_type: The remote administration update type 'something' is invalid. Must be one of 'core' or 'core_contrib'.
Invalid source environment:
value:
error: validation_failed
message:
deploy_environment: The source environment is not valid.
No parameters:
value:
error: validation_failed
message:
general: No fields were set to update. No action performed.
Pause until must be in the future:
value:
error: validation_failed
message:
pause_until: The pause until timestamp must be in the future.
Remote administration not availble for application:
value:
error: validation_failed
message:
general: Remote administration is not available for this application.
Source environment does not belong to application:
value:
error: validation_failed
message:
deploy_environment: The source environment does not belong to this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Does not have remote administration:
value:
error: forbidden
message: This application does not have remote administration.
Remote administration not available:
value:
error: forbidden
message: Remote admin is not available on non-hosted applications.
Unsufficient permissions:
value:
error: forbidden
message: You do not have permission to edit the remote administration settings for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found or does not exist:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Modifies the Remote Administration Settings for an Application.
tags:
- Applications
x-cli-name: applications:ra-settings-update
/applications/{applicationUuid}/settings/security:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
deprecated: true
description: Returns the security policy settings for this application.
operationId: getApplicationSecuritySettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings
self:
href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security
allowed_ips:
- 127.0.0.1
- 8.8.8.8
application_uuid: abcd1234-1111-2222-3333-0e02b2c3d470
tfa_required: true
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_security-settings'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns the Security Policy Settings for This Application.
tags:
- Applications
x-cli-name: applications:security-settings-find
put:
deprecated: true
description: Modifies the security policy settings for an application.
operationId: putApplicationSecuritySettings
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
configuration_set: true
status:
- 127.0.0.1
- 0.0.0.0
schema:
properties:
allowed_ips:
description: 'The list of IPs to whitelist. Set to `null` to disable IP whitelisting.
'
items:
format: ipv4
type: string
nullable: true
type: array
tfa_required:
description: The configuration set to use.Whether TFA is required for application authentication.
type: boolean
type: object
application/x-www-form-urlencoded:
schema:
example:
configuration_set: true
status:
- 127.0.0.1
- 0.0.0.0
properties:
allowed_ips:
description: 'The list of IPs to whitelist. Set to `null` to disable IP whitelisting.
'
items:
format: ipv4
type: string
nullable: true
type: array
tfa_required:
description: The configuration set to use.Whether TFA is required for application authentication.
type: boolean
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
message: The security policy settings have been updated.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'400':
content:
application/hal+json:
examples:
Invalid IP address in list:
value:
error: validation_failed
message:
allowed_ips: The IP address \"not-a-valid-ip-address\" is invalid.
Invalid IP list:
value:
error: validation_failed
message:
allowed_ips: The list of allowed IPs is invalid. Must either be an array of IPs to whitelist, or null to disable IP whitelisting.
No parameters:
value:
error: validation_failed
message:
general: No fields were set to update. No action performed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
Insufficient permissions:
value:
error: forbidden
message: You do not have permission to edit the security policy settings for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found or does not exist:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Action unavailable:
value:
error: conflict
message: The security policy is already configured to these settings.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Modifies the Security Policy Settings for an Application.
tags:
- Applications
x-cli-name: applications:security-settings-update
/applications/{applicationUuid}/tags:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of application tags associated with this application.
operationId: getApplicationTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags/Dev
color: orange
context:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
organization:
uuids:
- 2375e327-3fff-11e3-9170-12313920a02c
name: Dev
_links:
filter:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags
sort:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?sort}
templated: true
pagination:
limit: 1
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tags'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Application Tags Associated with This Application.
tags:
- Applications
x-cli-name: applications:tag-list
post:
description: Creates a new application tag.
operationId: postApplicationsTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
requestBody:
content:
application/hal+json:
example:
color: green
name: Dev
schema:
description: Application tags.
properties:
color:
description: The color name of the application tag found via the GET /api/options/colors endpoint.
type: string
name:
description: The label of the application tag.
maxLength: 16
minLength: 2
type: string
required:
- name
- color
type: object
application/x-www-form-urlencoded:
example:
color: green
name: Dev
schema:
description: Application tags.
properties:
color:
description: The color name of the application tag found via the GET /api/options/colors endpoint.
type: string
name:
description: The label of the application tag.
maxLength: 16
minLength: 2
type: string
required:
- name
- color
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/773fca86-9d87-45dc-9220-9ba38306bbb1
parent:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb
self:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags
message: The tag has been added to the application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'404':
content:
application/hal+json:
examples:
No user:
value:
error: not_found
message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a New Application Tag.
tags:
- Applications
x-cli-name: applications:tags-create
/applications/{applicationUuid}/tags/{tagName}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
delete:
description: Deletes an application tag.
operationId: deleteApplicationTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_tag-name'
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/37cdf705-9774-4526-9bf0-9feb279630ee
parent:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags
self:
href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags/test_tag
message: The tag has been removed from the application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'404':
content:
application/hal+json:
examples:
No user:
value:
error: not_found
message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Deletes an Application Tag.
tags:
- Applications
x-cli-name: applications:tags-delete
/applications/{applicationUuid}/tasks:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of tasks associated with this application. A task represents an item of work to be done, initiated by someone (typically the current user) associated with the application.
Filterable fields:
* `name`
* `title`
* `created`
* `completed`
* `started`
Sortable fields:
* `name`
* `title`
* `created`
* `completed`
* `started`
'
operationId: getApplicationTasks
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/8c6dde1f-fd0c-45e3-b6a3-f335397a1a76
completed_at: '2019-04-16T13:24:55-04:00'
created_at: '2019-04-16T13:24:55-04:00'
description: Application Example Application has been added to team Example Team
id: 8c6dde1f-fd0c-45e3-b6a3-f335397a1a76
labels:
- teams
metadata:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
author:
actual_uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
created: 1555435495
organization:
uuids:
- 1734f8b7-9fd0-4150-92a8-325c52229554
subscription:
uuids:
- bbb28c3b-5eba-41ce-b54e-798d60f02a14
team:
uuids:
- e1cc8591-1f28-44d4-912a-371311ac6095
user:
uuids:
- d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
name: ApplicationAddedToTeam
progress: 100
reference_uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
started_at: '2019-04-16T13:24:55-04:00'
status: completed
title: Application added to team.
type: task
user:
created_at: '2015-08-14T17:37:21-04:00'
first_name: Example
last_login_at: '2019-05-23T16:12:12-04:00'
last_name: User
mail: example.user@example.com
picture_url: https://accounts.acquia.com/images/users/d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a/style/avatar
username: example.user
uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a
uuid: 8c6dde1f-fd0c-45e3-b6a3-f335397a1a76
- _links:
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/a0b253b7-df89-4b45-950b-f1d1e8873d30
completed_at: '2019-01-25T04:24:46-05:00'
created_at: '2019-01-25T04:24:32-05:00'
description: Files copied from "prod" to "dev".
id: a0b253b7-df89-4b45-950b-f1d1e8873d30
labels:
- hosting
metadata:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
author:
actual_uuid: 66597696-118c-4e18-b7e8-d027df8d5faa
uuid: 66597696-118c-4e18-b7e8-d027df8d5faa
created: 1548408272
environment:
ids:
- 925-185f07c7-9c4f-407b-8968-67892ebcb38a
- 927-185f07c7-9c4f-407b-8968-67892ebcb38a
source: 925-185f07c7-9c4f-407b-8968-67892ebcb38a
target: 927-185f07c7-9c4f-407b-8968-67892ebcb38a
hosting:
task:
id: '12345678'
master: example
organization:
uuids:
- 1734f8b7-9fd0-4150-92a8-325c52229554
subscription:
uuids:
- bbb28c3b-5eba-41ce-b54e-798d60f02a14
user:
uuids:
- 66597696-118c-4e18-b7e8-d027df8d5faa
name: FilesCopied
progress: 0
reference_uuid: a0b253b7-df89-4b45-950b-f1d1e8873d30
started_at: '2019-01-25T04:24:32-05:00'
status: completed
title: Files copied
type: task
user:
created_at: '2015-08-13T19:37:00-04:00'
first_name: Example
last_login_at: '2019-05-30T18:08:36-04:00'
last_name: User
mail: example.user.2@example.com
picture_url: https://accounts.acquia.com/images/users/66597696-118c-4e18-b7e8-d027df8d5faa/style/avatar
username: example.user.2
uuid: 66597696-118c-4e18-b7e8-d027df8d5faa
uuid: a0b253b7-df89-4b45-950b-f1d1e8873d30
_links:
filter:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a
self:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks
sort:
href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-tasks'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Tasks Associated with This Application by its UUID.
tags:
- Applications
x-cli-name: applications:task-list
/applications/{applicationUuid}/teams:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of teams associated with this application by its UUID.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getApplicationTeams
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c
created_at: 2013-10-28T14:16:07-0700
name: Team Name 1
organization:
name: Sample Organization
uuid: 2375e327-3fff-11e3-9170-12313920a02c
updated_at: 2015-02-19T08:53:10-0800
uuid: abcd1234-82b5-11e3-9170-12313920a02c
- _links:
self:
href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f
created_at: 2014-05-27T11:55:39-0700
name: Team Name 2
organization:
name: Sample Organization
uuid: 2375e327-3fff-11e3-9170-12313920a02c
updated_at: 2015-01-30T05:49:16-0800
uuid: 1234abcd-82b5-11e3-9170-12313920a02c
_links:
parent:
href: https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8
self:
href: https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8/teams
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications-teams'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Teams Associated with This Application.
tags:
- Applications
x-cli-name: applications:team-list
components:
schemas:
Acquia_Cloud_API_Documentation_permission:
properties:
description:
description: The description of the permission.
nullable: true
type: string
flags:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission-flags'
group_label:
description: The human readable label for the group.
type: string
label:
description: The human readable label for the permission.
type: string
name:
description: The name of the permission.
type: string
required:
- name
- label
- description
- group_label
- flags
type: object
Acquia_Cloud_API_Documentation_code-studio-project:
description: The model for a Code Studio project.
properties:
_embedded:
description: Contains the embedded Acquia Cloud user.
properties:
application:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
application_id:
description: The associated application id.
format: uuid
type: string
status:
description: The status of the GitLab project
enum:
- active
- inactive
- installing
- install-failed
- deleted
- deleting
- delete-failed
type: string
required:
- application_id
- status
- _embedded
- _links
type: object
Acquia_Cloud_API_Documentation_ux-messages:
properties:
_embedded:
description: A collection of application messages matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_configuration-set:
description: An Acquia Search configuration set.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
application_uuid:
description: The UUID for the application the search configuration belongs to.
type: string
flags:
description: The collection of flags for the search configuration set.
properties:
custom:
description: Indicates whether the search configuration set is a custom configuration set.
type: boolean
type: object
health:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
id:
description: The search configuration set ID.
type: string
label:
description: The human-readable search configuration set label.
type: string
status:
description: The provisioning status of the search configuration set.
enum:
- active
- pending
- failed
- inactive
type: string
required:
- id
- application_uuid
- label
- flags
- status
- _links
type: object
Acquia_Cloud_API_Documentation_application:
properties:
_embedded:
description: Entities related to the application.
properties:
organization:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub-embedded'
subscription:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub-embedded'
tags:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag-embedded'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
flags:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-flags'
hosting:
description: Hosting details for this application.
properties:
id:
description: The hosting ID.
type: string
type:
description: The hosting type.
enum:
- ace
- acp
- acsf
- free
- network
- search
- unknown
type: string
type: object
id:
description: The unique internal ID of the application.
type: integer
name:
description: The name of the application.
type: string
organization:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
status:
description: The current application status.
enum:
- normal
- provisioning
type: string
subscription:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub'
type:
description: The type of application supported.
enum:
- drupal
- node
- ssg
type: string
uuid:
description: The UUID of the application.
format: uuid
type: string
required:
- id
- uuid
- name
- hosting
- subscription
- organization
- flags
- type
- status
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_artifact:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
created_at:
description: The time at which the artifact was created.
format: date-time
type: string
id:
description: The unique ID of the artifact.
type: integer
name:
description: The name of the artifact.
type: string
state:
description: The state of the artifact.
enum:
- delete-failed
- deleted
- pending-delete
- pending-upload
- ready
- upload-failed
type: string
required:
- id
- name
- state
- created_at
- _links
type: object
Acquia_Cloud_API_Documentation_remote-administration-settings:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
application_uuid:
description: The application UUID.
format: uuid
type: string
deploy_at:
description: The ISO-8601 formatted date/time to deploy RA at. Only applicable for 'full' and 'inform' update modes and when it is in future.
nullable: true
type: string
deploy_environment:
description: The environment to deploy the code and production database to for testing.
type: string
flags:
description: Remote administration settings flags.
properties:
copy_database:
type: boolean
copy_files:
type: boolean
merge_tag:
type: boolean
type: object
merge_branch:
description: The development branch into which the update tag will be merged.
nullable: true
type: string
pause_until:
description: The ISO-8601 formatted date/time to pause RA until. Only applicable for 'full' and 'inform' update modes and when it is in future.
nullable: true
type: string
source_environment:
description: The update source environment. Only applicable for 'full' mode.
type: string
update_mode:
description: The remote administration update setting.
enum:
- full
- inform
- none
type: string
update_type:
description: The remote administration update type (i.e. what to update).
enum:
- core
- core_contrib
type: string
type: object
Acquia_Cloud_API_Documentation_application-flags:
description: An array of various flags that indicate functionality associated with applications.
properties:
remote_admin:
description: Whether this application has remote administration enabled.
type: boolean
type: object
Acquia_Cloud_API_Documentation_application-metadata:
description: Application metadata.
properties:
uuids:
description: Collection of application UUIDs.
items:
description: The application UUID.
format: uuid
type: string
type: array
type: object
Acquia_Cloud_API_Documentation_security-settings:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
allowed_ips:
description: A list of IPs and CIDR values allowed to access an application. Set to null to disable whitelisting.
items:
type: string
type: array
tfa_required:
description: Whether TFA is required for an application.
type: boolean
uuid:
description: The application UUID.
format: uuid
type: string
type: object
Acquia_Cloud_API_Documentation_resource-tag-embedded:
description: An associated tag.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
color:
description: The color of the tag.
type: string
name:
description: The name of the tag.
type: string
required:
- name
- color
- _links
type: object
Acquia_Cloud_API_Documentation_artifact-stub:
nullable: true
properties:
id:
description: The artifact identifier.
format: id
type: integer
name:
description: The name of the artifact.
type: string
required:
- name
- id
type: object
Acquia_Cloud_API_Documentation_applications:
properties:
_embedded:
description: A collection of applications.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-no-embedded'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_subscription-stub:
description: The subscription this application belongs to.
properties:
name:
description: The name of the subscription.
type: string
uuid:
description: The UUID of the subscription.
format: uuid
type: string
required:
- uuid
- name
type: object
Acquia_Cloud_API_Documentation_search:
description: A collection of links that provides traversal of search endpoints.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
required:
- _links
type: object
Acquia_Cloud_API_Documentation_usage:
description: A collection of traversal links for an entity.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
required:
- _links
type: object
Acquia_Cloud_API_Documentation_applications-tasks:
properties:
_embedded:
description: A collection of tasks matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_task'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_email-domain:
description: The Email Domain
properties:
domain_name:
description: The domain name.
format: hostname
type: string
flags:
description: Additional Email Domain information.
properties:
associated:
description: Whether or not Platform Email has been associated with the application.
type: boolean
type: object
health:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_health'
uuid:
description: The UUID of the email domain.
format: uuid
type: string
required:
- uuid
- domain_name
- flags
- health
type: object
Acquia_Cloud_API_Documentation_message:
properties:
message:
description: A simple message returned from the response.
type: string
required:
- message
type: object
Acquia_Cloud_API_Documentation_applications-teams:
properties:
_embedded:
description: A collection of teams matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_ides:
properties:
_embedded:
description: A collection of Cloud IDEs matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ide'
type: array
required:
- items
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_environments:
properties:
_embedded:
description: A collection of environments matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_ux-message-flags:
description: An array of various flags associated with a message.
properties:
active:
type: boolean
dismissed:
type: boolean
dismissible:
type: boolean
type: object
Acquia_Cloud_API_Documentation_hosting-settings:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
hosting_id:
description: The application's hosting identifier.
type: string
type:
description: The application's hosting type.
type: string
uuid:
description: The application UUID.
format: uuid
type: string
type: object
Acquia_Cloud_API_Documentation_application-usage-metrics:
description: A collection of application usage metrics.
properties:
_embedded:
description: A collection of application metric items matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-usage-metric'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_application-feature:
properties:
description:
description: A description of the feature flag.
type: string
label:
description: The feature flag friendly name.
type: string
name:
description: The feature flag machine name.
type: string
required:
- name
- label
- description
type: object
Acquia_Cloud_API_Documentation_user-stub:
properties:
first_name:
description: The user's first name.
type: string
last_name:
description: The user's last name.
type: string
mail:
description: The user's email address.
format: email
type: string
picture_url:
description: The URI for the user's picture.
format: uri
nullable: true
type: string
username:
description: The user's internal user name.
type: string
uuid:
description: The user's UUID.
format: uuid
type: string
required:
- uuid
- first_name
- last_name
- mail
- picture_url
- username
type: object
Acquia_Cloud_API_Documentation_environment-flags:
description: An array of various flags that indicate functionality associated with the environment.
properties:
cde:
description: Determines if the environment is on-demand.
type: boolean
cdn:
description: Determines if the environment has Platform CDN enabled.
type: boolean
cloud-actions:
description: Determines if the environment has Cloud Actions enabled.
type: boolean
eips:
description: Determines if the environment has Web EIPs enabled.
type: boolean
email:
description: Determines if the environment has Platform Email enabled.
type: boolean
hsd:
description: Determines if the environment is under high-site density.
type: boolean
livedev:
description: Determines if the environment has live development enabled.
type: boolean
multi_region:
description: Whether or not the environment is multi-regioned.
type: boolean
multicert:
description: Determines if the environment has multicert enabled.
type: boolean
production:
description: Determines if the environment is production.
type: boolean
production_mode:
description: Determines if the environment has production mode enabled.
type: boolean
remote_admin:
description: Determines if the environment is a remote administration environment.
type: boolean
varnish:
description: Determines if the environment has Varnish.
type: boolean
varnish_over_ssl:
description: Determines if the environment is configured for varnish over SSL.
type: boolean
type: object
Acquia_Cloud_API_Documentation_application-databases:
description: Collection of application databases.
properties:
_embedded:
description: A collection of database names matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-database-name'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_team:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
created_at:
description: The date the team was created.
format: date-time
type: string
name:
description: The name of the team.
type: string
organization:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
updated_at:
description: The date the team was last updated.
format: date-time
type: string
uuid:
description: The UUID of the team.
format: uuid
type: string
required:
- uuid
- name
- created_at
- updated_at
- organization
- _links
type: object
Acquia_Cloud_API_Documentation_application-database-name:
description: Application database name.
properties:
name:
description: The database name.
maxLength: 63
minLength: 1
type: string
required:
- name
type: object
Acquia_Cloud_API_Documentation_legacy-product-keys-settings:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
acquia_connector:
description: Acquia Connector legacy credentials.
properties:
identifier:
description: The Acquia Connector site identifier.
type: string
key:
description: The Acquia Connector key.
type: string
type: object
cloud_api:
description: Cloud API legacy credentials.
properties:
key:
description: The Cloud API key.
type: string
username:
description: The Cloud API username (Subscription UUID).
format: uuid
type: string
type: object
type: object
Acquia_Cloud_API_Documentation_organization-stub-embedded:
description: A related organization.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
name:
description: The human-readable organization name.
type: string
uuid:
description: The organization's UUID.
format: uuid
type: string
required:
- uuid
- name
type: object
Acquia_Cloud_API_Documentation_remote-administration:
properties:
copy_database:
description: Whether to copy database from production to testing environment.
type: boolean
copy_files:
description: Whether to copy files from production to testing environment.
type: boolean
deploy_at:
description: What date/time to deploy RA updates at (if applicable).
nullable: true
type: string
deploy_environment:
description: The environment id of the environment to deploy to.
type: string
merge_branch:
description: The development branch into which to merge the update tag.
type: string
merge_tag:
description: Whether to automatically merge the approved code into your development branch.
type: boolean
pause_until:
description: What date/time to pause RA updates until (if applicable).
nullable: true
type: string
source_environment:
description: The environment id of the environment to use as a starting point for testing.
type: string
update_mode:
description: The update mode to select.
enum:
- update
- inform
- none
type: string
update_type:
description: What components to update (core only or core and contrib modules).
enum:
- core
- core_contrib
type: string
required:
- update_mode
type: object
Acquia_Cloud_API_Documentation_settings:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
type: object
Acquia_Cloud_API_Documentation_ux-message:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
body:
description: The message body.
nullable: true
type: string
expire_at:
description: The UTC timestamp of when the message expires.
format: date-time
type: string
filters:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-filters'
flags:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-message-flags'
id:
description: The message identifier.
type: integer
start_at:
description: The UTC timestamp of when the message started.
format: date-time
type: string
title:
description: The message title.
type: string
url:
description: The message url.
format: uri
nullable: true
type: string
uuid:
description: The message unique identifier.
format: uuid
type: string
weight:
description: The message priority weight.
type: integer
required:
- id
- uuid
- title
- body
- url
- filters
- flags
- weight
- start_at
- expire_at
- _links
type: object
Acquia_Cloud_API_Documentation_vcs:
properties:
path:
description: The path or branch name.
nullable: true
type: string
type:
description: The type of VCS.
enum:
- git
- svn
type: string
url:
description: The VCS url.
type: string
required:
- type
- path
- url
type: object
Acquia_Cloud_API_Documentation_application-no-embedded:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
flags:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-flags'
hosting:
description: Hosting details for this application.
properties:
id:
description: The hosting ID.
type: string
type:
description: The hosting type.
enum:
- ace
- acp
- acsf
- free
- network
- search
- unknown
type: string
type: object
id:
description: The unique internal ID of the application.
type: integer
name:
description: The name of the application.
type: string
organization:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-stub'
status:
description: The current application status.
enum:
- normal
- provisioning
type: string
subscription:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-stub'
type:
description: The type of application supported.
enum:
- drupal
- node
- ssg
type: string
uuid:
description: The UUID of the application.
format: uuid
type: string
required:
- id
- uuid
- name
- hosting
- subscription
- organization
- flags
- type
- status
- _links
type: object
Acquia_Cloud_API_Documentation_application-features:
properties:
_embedded:
description: A collection of application feature flags.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-feature'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_environment-metadata:
description: Environment metadata.
properties:
ids:
description: An array of environment identifiers.
items:
type: string
type: array
type: object
Acquia_Cloud_API_Documentation_configuration-sets:
description: A collection of configuration sets.
properties:
_embedded:
description: A collection of configuration sets.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_configuration-set'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
pagination:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_pagination'
total:
description: The number of items returned in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_message-with-links:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
message:
description: The human-friendly confirmation of the creation of the resource.
type: string
required:
- message
- _links
type: object
Acquia_Cloud_API_Documentation_organization-stub:
properties:
name:
description: The human-readable organization name.
type: string
uuid:
description: The organization's UUID.
format: uuid
type: string
required:
- uuid
- name
type: object
Acquia_Cloud_API_Documentation_code-flags:
description: An array of various flags that indicate functionality associated with code branches and tags on applications.
properties:
tag:
type: boolean
type: object
Acquia_Cloud_API_Documentation_applications-notifications:
properties:
_embedded:
description: A collection of notifications matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_notification-stub'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_subscription-metadata:
description: Subscription metadata.
properties:
uuids:
description: An array of subscription unique identifiers.
items:
format: uuid
type: string
type: array
type: object
Acquia_Cloud_API_Documentation_notification-stub:
description: A notification about an event or a task.
properties:
_embedded:
description: Data related to the notification, such as the author.
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
completed_at:
description: The time that the task or event this notification is tracking was completed at.
format: date-time
type: string
context:
description: Contextual data related to the notification.
type: object
created_at:
description: The time that this notification was created.
format: date-time
type: string
description:
description: The notification description.
type: string
event:
description: The notification event.
type: string
label:
description: The human readable notification label.
type: string
progress:
description: The notification progress.
maximum: 100
minimum: 0
type: integer
status:
description: The status of the notification.
enum:
- completed
- in-progress
- failed
type: string
uuid:
description: The notification unique identifier.
format: uuid
type: string
required:
- uuid
- event
- label
- description
- created_at
- completed_at
- status
- progress
- context
- _links
type: object
Acquia_Cloud_API_Documentation_code:
properties:
_embedded:
description: A collection of branch and tag information.
properties:
items:
items:
properties:
flags:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_code-flags'
name:
description: The name of the branch or tag.
type: string
required:
- name
- flags
type: object
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_application-stub:
properties:
name:
description: The name of the application.
type: string
uuid:
description: The application UUID.
format: uuid
type: string
required:
- name
- uuid
type: object
Acquia_Cloud_API_Documentation_applications-permissions:
properties:
_embedded:
description: A collection of permissions matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permission'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
flags:
description: Additional information about the permissions.
properties:
administrator:
description: Whether the current user is able to administrate the application.
type: boolean
required:
- administrator
type: object
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- flags
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_application-usage-metric:
description: Provides details about views and visits for an application.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
datapoints:
description: The data points for the pricing metrics request.
items:
description: Each element includes the value for the requested metric and the sampling time.
items:
description: The first element is the metric value and the second is the sampling time.
type: string
type: array
type: array
last_data_at:
description: The last time data was polled for the requested metric.
format: date-time
nullable: true
type: string
metadata:
description: The metadata for the data points being returned.
properties:
application:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-metadata'
environment:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-metadata'
subscription:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_subscription-metadata'
type: object
metric:
description: The type of metric requested.
enum:
- views
- visits
type: string
required:
- metric
- datapoints
- metadata
- last_data_at
type: object
Acquia_Cloud_API_Documentation_subscription-stub-embedded:
description: A related subscription.
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
name:
description: The name of the subscription.
type: string
uuid:
description: The UUID of the subscription.
format: uuid
type: string
required:
- uuid
- name
- _links
type: object
Acquia_Cloud_API_Documentation_artifacts:
properties:
_embedded:
description: A collection of artifacts.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_pagination:
description: A collection of pagination properties.
properties:
limit:
description: The limit on the number of objects in the collection.
type: integer
offset:
description: The offset on the retrieved objects in the collection.
type: integer
total:
description: The total number of objects in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_permission-flags:
description: An array of various flags regarding the status of the permission.
properties:
deprecated:
description: Whether the permission is deprecated or not.
type: boolean
type: object
Acquia_Cloud_API_Documentation_user-profile:
description: A user profile.
properties:
created_at:
description: The date the user was created.
format: date-time
type: string
email:
description: The user's email address.
format: email
type: string
first_name:
description: The user's first name.
type: string
last_login_at:
deprecated: true
description: The date/time of the last login for the user.
format: date-time
nullable: true
type: string
last_name:
description: The user's last name.
type: string
picture_url:
description: The URL for the user's picture.
format: uri
nullable: true
type: string
username:
description: The user's internal user name.
type: string
uuid:
description: The user's UUID.
format: uuid
type: string
required:
- uuid
- first_name
- last_name
- last_login_at
- created_at
- email
- picture_url
- username
type: object
Acquia_Cloud_API_Documentation_environment-configuration:
description: An array of configuration details for the environment.
properties:
apcu:
default: 32
description: APCu shared memory size per web server.
maximum: 512
minimum: 32
nullable: true
type: integer
client_max_body_size:
default: 256
description: Sets the maximum size of the client request body.
maximum: 1024
minimum: 0
nullable: true
type: integer
interned_strings_buffer:
default: 8
description: Sets PHP Opcache key count per server.
maximum: 32
minimum: 8
nullable: true
type: integer
max_execution_time:
default: 300
description: Limits PHP request time in seconds.
maximum: 300
minimum: 1
nullable: true
type: integer
max_input_vars:
default: 1000
description: Limits the number of various request items in PHP.
maximum: 20000
minimum: 500
nullable: true
type: integer
max_post_size:
default: 256
description: Sets the PHP limit on POST body size.
maximum: 1024
minimum: 64
nullable: true
type: integer
memcached_limit:
default: 64
description: Sets the maximum amount of memory in MB that can be allocated to memcached. Only available on Acquia Cloud Next.
maximum: 12288
minimum: 0
nullable: true
type: integer
memory_limit:
default: 128
description: Limits PHP request memory usage in megabytes.
maximum: 1024
minimum: 128
nullable: true
type: integer
opcache:
default: 96
description: This is the total amount of memory available for caching precompiled script bytecode per PHP/FPM process.
maximum: 512
minimum: 96
nullable: true
type: integer
operating_system:
description: The operating system version.
type: string
upload_max_filesize:
default: 256
description: Sets the maximum size of an uploaded file.
maximum: 1024
minimum: 0
nullable: true
type: integer
version:
description: The PHP or Node version.
type: string
type: object
Acquia_Cloud_API_Documentation_validation-error:
description: A validation error.
properties:
error:
description: The error summary.
type: string
message:
additionalProperties:
type: string
description: The validation error message keyed by its field or group name.
type: object
required:
- error
- message
type: object
Acquia_Cloud_API_Documentation_health:
description: The current health for this resource.
properties:
code:
description: The status code for the current health.
type: string
details:
description: Full details about the current health code.
type: string
summary:
description: A brief summary that explains why the health code is present.
type: string
type: object
Acquia_Cloud_API_Documentation_resource-tags:
properties:
_embedded:
description: A collection of tags matching the request parameters.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_resource-tag'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
total:
description: The number of items returned in the collection.
type: integer
required:
- total
- _links
- _embedded
type: object
Acquia_Cloud_API_Documentation_email-domains:
properties:
_embedded:
description: A collection of email domains.
properties:
items:
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_email-domain'
type: array
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
pagination:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_pagination'
total:
description: The number of items returned in the collection.
type: integer
type: object
Acquia_Cloud_API_Documentation_ide:
properties:
_embedded:
properties:
owner:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-profile'
type: object
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
label:
description: The human-friendly label of the Cloud IDE.
type: string
status:
description: The current provisioning status of the Cloud IDE.
enum:
- active
- provisioning
- deleting
- updating
- provision-failed
- update-failed
- delete-failed
type: string
uuid:
description: The unique identifier of the Cloud IDE.
format: uuid
type: string
required:
- uuid
- label
- status
- _links
type: object
Acquia_Cloud_API_Documentation_resource-tag:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
color:
description: The color of the tag.
type: string
context:
description: Metadata related to the tag.
properties:
application:
description: A collection of application metadata for the tag.
properties:
uuids:
description: An array of application UUIDs.
items:
description: The application UUID.
format: uuid
type: string
type: array
type: object
organization:
description: A collection of organization metadata for the tag.
properties:
uuids:
description: An array of organization UUIDs.
items:
description: The organization UUID.
format: uuid
type: string
type: array
type: object
type: object
name:
description: The name of the tag.
type: string
required:
- name
- color
- context
- _links
type: object
Acquia_Cloud_API_Documentation_ux-message-filters:
description: Defines where a message should appear.
properties:
display_mode:
description: How the message should be displayed.
enum:
- bar
- list
type: string
paths:
description: Collection of paths.
items:
description: Paths where a message should appear.
type: string
type: array
type:
description: The message type.
enum:
- alert
- general
- new
- warning
type: string
type: object
Acquia_Cloud_API_Documentation_environment:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
active_domain:
description: The active domain name for this environment.
format: hostname
type: string
application:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_application-stub'
artifact:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_artifact-stub'
balancer:
description: 'The balancer type.
- balancers: The environment is behind a Legacy balancer.
- elb: The environment is behind an ELB balancer.
- cluster: The environment is behind an Edge Cluster balancer.
'
enum:
- balancers
- elb
- cluster
type: string
configuration:
description: A collection of environment configuration information.
nullable: true
properties:
operating_system:
description: The environment operation system.
type: string
php:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-configuration'
type: object
default_domain:
description: The default domain name for this environment.
format: hostname
type: string
domains:
description: An array of domain names attached to this environment.
items:
format: hostname
type: string
type: array
flags:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_environment-flags'
id:
description: The ID of the environment. The ID is a compound key consisting of the internal database ID of the environment and the application UUID.
type: string
image_url:
description: The URL to the image for this environment.
format: uri
nullable: true
type: string
ips:
deprecated: true
description: An array of IP addresses attached to this environment.
items:
format: ipv4
type: string
type: array
label:
description: The human-readable name of the environment.
type: string
name:
description: The stage name of the environment.
type: string
platform:
description: 'The platform type.
- cloud: The environment is hosted on a Cloud Classic Platform.
- cloud-next: The environment is hosted on a Cloud Next Platform.
- unknown: The host information is not available for the environment.
'
enum:
- cloud
- cloud-next
- unknown
type: string
region:
description: The region the environment resides in.
type: string
size:
description: The size of the environment. Will be null if the environment type does not support sizes.
enum:
- small
- medium
- large
- unknown
nullable: true
type: string
ssh_url:
description: The URL used to SSH into the environment.
type: string
status:
description: The status of this environment.
type: string
type:
description: 'The type of environment.
- node: A NodeJS environment.
- drupal: A Drupal environment.
- ssg: A Static Site Generator environment.
- unknown: We were unable to determine the environment type.
'
enum:
- node
- drupal
- ssg
- unknown
type: string
vcs:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_vcs'
weight:
description: The environment weight for display purposes.
nullable: true
type: integer
required:
- id
- label
- name
- application
- domains
- active_domain
- default_domain
- image_url
- ssh_url
- ips
- region
- balancer
- platform
- status
- type
- size
- weight
- vcs
- flags
- configuration
- artifact
- _links
type: object
Acquia_Cloud_API_Documentation_error:
properties:
error:
description: The error summary.
type: string
message:
description: The long description for the returned error.
type: string
required:
- error
- message
type: object
Acquia_Cloud_API_Documentation_links:
description: HAL links about the current resource.
properties:
self:
description: A link to this page.
properties:
href:
description: The URI for this page.
format: uri
type: string
required:
- href
type: object
required:
- self
type: object
Acquia_Cloud_API_Documentation_task:
properties:
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
completed_at:
description: The date that the task was completed.
format: date-time
type: string
created_at:
description: The date that this task was created.
format: date-time
type: string
description:
description: The description of the task.
nullable: true
type: string
labels:
description: Categorization labels associated with the task
items:
type: string
type: array
metadata:
properties:
author:
description: The task author.
properties:
uuid:
description: The task author UUID.
format: uuid
type: string
type: object
created:
description: When the task was created.
type: integer
type: object
name:
description: The machine name of the task.
type: string
progress:
description: The progress of the event, from 0 to 100.
maximum: 100
minimum: 0
type: integer
reference_uuid:
description: The UUID of the parent task. If there is no parent, this will be the task UUID.
format: uuid
type: string
started_at:
description: The date that the task was started.
format: date-time
type: string
status:
description: The status of the task.
type: string
title:
description: The title of the task.
type: string
type:
description: The type of task.
type: string
user:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user-stub'
uuid:
description: The UUID of the task.
format: uuid
type: string
required:
- progress
- user
- uuid
- name
- title
- description
- created_at
- started_at
- status
- type
- metadata
- labels
- reference_uuid
- _links
type: object
parameters:
Acquia_Cloud_API_Documentation_filter:
description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.
There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:
* Equals: `= (%3D)`
* Does not equal: `!= (!%3D)`
* Greater than: `> (%3E)`
* Less than: `< (%3C)`
* Greater than or equal to: `>= (%3E%3D)`
* Less than or equal to: `<= (%3C%3D)`
* Contains substring: `=@ (%3D@)`
* Does not contain substring: `!@ (!@)`
Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).
Some examples:
* `filter=field%3Dvalue` (`field` equals `''value''`)
* `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)
* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)
* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals `''value''` AND `field2` > `5`)
'
in: query
name: filter
required: false
schema:
minimum: 1
type: string
Acquia_Cloud_API_Documentation_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_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_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_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_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_name:
description: A name that uniquely identifies an entity.
example: drupal8
in: path
name: name
required: true
schema:
type: string
Acquia_Cloud_API_Documentation_offset:
description: An integer to signify the offset to paginate from.
example: 10
in: query
name: offset
required: false
schema:
type: integer
Acquia_Cloud_API_Documentation_sort:
description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.
'
example: field1,-field2
in: query
name: sort
required: false
schema:
minimum: 1
type: string
Acquia_Cloud_API_Documentation_limit:
description: The maximum number of items to return.
example: 10
in: query
name: limit
required: false
schema:
type: integer
Acquia_Cloud_API_Documentation_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_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_usage-metric:
description: A usage data metric type.
example: views
in: path
name: usageMetric
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_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
securitySchemes:
Acquia_Cloud_API_Documentation_OAuth2:
description: 'All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page.
### To generate a token:
1. Sign in to the [Acquia Cloud](https://cloud.acquia.com/) interface using your email address and Acquia password.
2. Click your user avatar in the upper right corner, and then click **Account Settings**.
3. On the Profile page, click **API Tokens**.
4. Click **Create Token**.
5. In the pop-up that appears, give your token a label so that you can easily find it later. Then click **Create Token**.
6. Copy your API key and API secret. Click **OK**.
'
flows:
clientCredentials:
scopes: {}
tokenUrl: https://accounts.acquia.com/api/token
type: oauth2
Codebase_Service_JWT:
description: Value for the Authorization header parameter.
in: header
name: Authorization
type: apiKey
MEO_Environment_Service_JWT:
description: Value for the Authorization header parameter.
in: header
name: Authorization
type: apiKey
Site_Service_JWT:
description: Value for the Authorization header parameter.
in: header
name: Authorization
type: apiKey