Acquia Applications API
The Applications API from Acquia — 36 operation(s) for applications.
OpenAPI Specification
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: <a href='https://docs.acquia.com/acquia-cloud/develop/api/auth/' target='_blank'>https://docs.acquia.com/acquia-cloud/develop/api/auth/</a>\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found <a href='https://docs.acquia.com/resources/useful-references' target='_blank'>here</a>. This script uses the <a href='https://oauth2-client.thephpleague.com/' target='_blank'>League/oauth2-client</a> library, installed via Composer.\n"
title: Acquia Cloud API 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`
* <s>`name`</s> (Deprecated)
* `organization_name`
* <s>`hosting`</s> (Deprecated) Use URL encoded colon (%3A) to separate realm and sitegroup, e.g. network%3An3 instead of network:n3
Sortable fields:
* `label`
* <s>`name`</s> (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
# --- truncated at 32 KB (257 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-applications-api-openapi.yml