Acquia Account API
The Account API from Acquia — 23 operation(s) for account.
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 API
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
servers: []
tags:
- name: Account
paths:
/account:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns details about your account.
operationId: getAccount
responses:
'200':
content:
application/hal+json:
example:
_links:
invites:
href: https://cloud.acquia.com/api/account/invites
messages:
href: https://cloud.acquia.com/api/account/messages
parent:
href: https://cloud.acquia.com/api/
self:
href: https://cloud.acquia.com/api/account
tokens:
href: https://cloud.acquia.com/api/account/tokens
company: Acquia, Inc.
country: United States
created_at: '2016-07-17T20:35:25+00:00'
features:
- ci-pipelines
- on-demand-environments
first_name: Jane
flags:
active: true
support: false
tfa: true
id: 1234567
job_function: IT Executive
job_title: ''
last_login_at: 2017-03-28T13:07:54-0500
last_name: Doe
mail: jane.doe@example.com
metadata:
applications:
recent:
- recent_at: 2016-03-04T13:07:54-0500
uuid: 8b83a104-2f09-11e9-b210-d663bd873d93
- recent_at: 2016-03-04T12:01:07-0500
uuid: 8b83a104-2f09-11e9-b210-d663bd873d93
- recent_at: 2016-03-04T12:01:05-0500
uuid: 8b83a104-2f09-11e9-b210-d663bd873d93
starred:
- 987c5c48-2f09-11e9-b210-d663bd873d93
- 9b684e30-2f09-11e9-b210-d663bd873d93
name: jane.doe
phone:
mobile: '5555555555'
office: null
tfa: '5555555555'
picture_url: https://accounts.acquia.com/images/users/82cff7ec-2f09-11e9-b210-d663bd873d93/style/avatar
state: Massachusetts
timezone: America/New_York
uuid: 82cff7ec-2f09-11e9-b210-d663bd873d93
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_user'
description: OK
'404':
content:
application/hal+json:
examples:
Does not exist:
value:
error: not_found
message: The user does not exist, or you do not have access to it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns Details About Your Account.
tags:
- Account
x-cli-name: accounts:find
/account/applications/{applicationUuid}/actions/mark-recent:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Marks an application as recently viewed. UUIDs and timestamps of recent applications are present in the "account" endpoint.
operationId: postAccountApplicationMarkRecent
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Marked as recently viewed:
value:
message: The application has been marked as recently viewed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
Does not exist:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Already on the recently viewed list:
value:
error: conflict
message: Unable to add an application to the recently viewed list.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Marks an Application as Recently Viewed.
tags:
- Account
x-cli-name: accounts:application-mark-recent
/account/applications/{applicationUuid}/actions/star:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Stars an application. UUIDs of starred applications are present in the "account" endpoint.
operationId: postAccountApplicationStar
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Starred:
value:
message: The application has been starred.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
Does not exist:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
User does not have access:
value:
error: not_found
message: The user does not have access to this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Unable to add:
value:
error: conflict
message: The application has already been starred by this user.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Stars an Application.
tags:
- Account
x-cli-name: accounts:application-star
/account/applications/{applicationUuid}/actions/unstar:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
description: Removes an application from the user's starred list. UUIDs of starred applications are present in the "account" endpoint.
operationId: postAccountApplicationUnstar
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Starred:
value:
message: The application has been unstarred.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
Does not exist:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
User does not have access:
value:
error: not_found
message: The user does not have access to this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Unable to add:
value:
error: conflict
message: The application is not currently starred by this user.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes an Application from the User's Starred List.
tags:
- Account
x-cli-name: accounts:application-unstar
/account/applications/{applicationUuid}/has-permission:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns whether your account has access to a specific application permission.
operationId: getAccountApplicationHasPermission
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_permission'
responses:
'200':
content:
application/hal+json:
example:
_links:
application:
href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93
self:
href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod
access: true
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_has-permission'
description: OK
'403':
content:
application/hal+json:
examples:
Do not have permission:
value:
error: forbidden
message: You do not have the 'example permission' permission for this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Application not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
Permission not found:
value:
error: not_found
message: The permission you are trying to look up does not exist.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Whether Your Account Has Access to a Specific Application Permission.
tags:
- Account
x-cli-name: accounts:application-has-permission
/account/applications/{applicationUuid}/is-admin:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns whether your account is an administrator for an application.
operationId: getAccountApplicationIsAdministrator
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
application:
href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93
self:
href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-admin
admin: true
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-administrator'
description: OK
'403':
content:
application/hal+json:
examples:
Do not have permission:
value:
error: forbidden
message: You do not have permission to administer this application.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Whether Your Account is an Administrator for an Application.
tags:
- Account
x-cli-name: accounts:is-application-admin
/account/applications/{applicationUuid}/is-owner:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns whether your account is the owner for an application.
operationId: getAccountApplicationIsOwner
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
application:
href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93
self:
href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-owner
owner: true
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_is-owner'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The application you are trying to access does not exist, or you do not have permission to access it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Returns Whether Your Account is the Owner for an Application.
tags:
- Account
x-cli-name: accounts:is-application-owner
/account/drush-aliases/download:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns the drush aliases as a compressed archive download.
operationId: getAccountDrushAliasesDownload
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_drush-version'
responses:
'200':
content:
application/gzip:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_file'
description: OK
'403':
content:
application/hal+json:
examples:
Version not supported:
value:
error: forbidden
message: Only Drush 8 and 9 are supported.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No Cloud API key found:
value:
error: not_found
message: No Cloud API key found for user with email address test@example.com.
No aliases found:
value:
error: not_found
message: No Drush aliases found for user with email address test@example.com.
No applications found:
value:
error: not_found
message: No hosted applications found for user with email address test@example.com.
User not found:
value:
error: not_found
message: The user does not exist, or you do not have access to it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns the Drush Aliases as a Compressed Archive Download.
tags:
- Account
x-cli-name: accounts:drush-aliases
/account/ides:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: Returns a list of Cloud IDEs associated with the current user.
operationId: getAccountIdes
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
application:
href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199
ide:
href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ide.ahdev.cloud
self:
href: https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7
web:
href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud
label: IDE Label 1
status: active
uuid: 9a83c081-ef78-4dbd-8852-11cc3eb248f7
- _links:
application:
href: https://cloud.acquia.com/api/applications/cc26f963-6e9e-49df-a159-230f75e455aa
ide:
href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ide.ahdev.cloud
self:
href: https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8
web:
href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud
label: IDE Label 2
status: active
uuid: feea197a-9503-4441-9f49-b4d420b0ecf8
_links:
parent:
href: https://cloud.acquia.com/api/account
self:
href: https://cloud.acquia.com/api/account/ides
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ides'
description: OK
'404':
content:
application/hal+json:
examples:
User not found:
value:
error: not_found
message: The user does not exist, or you do not have access to it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
summary: Acquia Returns a List of Cloud IDEs Associated with the Current User.
tags:
- Account
x-cli-name: accounts:ide-list
/account/invites:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Gets a list of all organization admin and team invites that are pending for the current user.
Filterable fields:
* `mail`
* `token`
* `author`
Sortable fields:
* `mail`
* `token`
* `author`
'
operationId: getAccountInvites
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
organization:
href: https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93
self:
href: https://cloud.acquia.com/api/invites/eb947b2c-2fe0-11e9-b210-d663bd873d93
applications:
- name: Example application
uuid: a6a494aa-1316-4867-b681-95e3d77a6b34
author:
first_name: Jane
last_name: Doe
mail: jane.doe@example.com
picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com
username: jane.doe
uuid: 0f1915e8-cd84-4386-94b8-21926fc376f5
created_at: '2012-05-15T12:00:00Z'
email: invitee@example.com
flags:
declined: false
organization:
name: Organization Name
uuid: e83c3532-2fe0-11e9-b210-d663bd873d93
roles:
- name: Senior Developer
uuid: fe79cb7a-2fe0-11e9-b210-d663bd873d93
team:
name: Team Name
uuid: 01d73cf8-2fe1-11e9-b210-d663bd873d93
token: dd9ea69fdcb6bee08b31a858b85535ec
uuid: eb947b2c-2fe0-11e9-b210-d663bd873d93
- _links:
organization:
href: https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93
self:
href: https://cloud.acquia.com/api/invites/0540f4ba-2fe1-11e9-b210-d663bd873d93
author:
first_name: Jane
last_name: Doe
mail: jane.doe@example.com
picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com
username: jane.doe
uuid: 0f1915e8-cd84-4386-94b8-21926fc376f5
created_at: '2012-05-15T12:00:00Z'
email: invitee@example.com
flags:
declined: false
organization:
name: Organization Name
uuid: e83c3532-2fe0-11e9-b210-d663bd873d93
token: dd9ea69fdcb6bee08b31a858b85535ec
uuid: 0540f4ba-2fe1-11e9-b210-d663bd873d93
_links:
parent:
href: https://cloud.acquia.com/api/account
self:
href: https://cloud.acquia.com/api/account/invites
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_account-invites'
description: OK
'404':
content:
application/hal+json:
examples:
User not found:
value:
error: not_found
message: The user does not exist, or you do not have access to it.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Gets a List of All Organization Admin and Team Invites That Are Pending for the Current User.
tags:
- Account
x-cli-name: accounts:invites-list
/account/messages:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
description: 'Returns a list of messages associated with the current user.
Filterable fields:
* `title`
* `message_type`
* `display_mode`
Sortable fields:
* `title`
* `message_type`
* `display_mode`
'
operationId: getAccountMessages
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
dismiss:
href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss
follow:
href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow
self:
href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2
body: null
expire_at: '2019-07-15T09:45:00-04:00'
filters:
display_mode: bar
paths: []
type: alert
flags:
active: true
dismissed: false
dismissible: true
id: 883581
start_at: '2019-07-07T09:45:00-04:00'
title: Example title
url: null
uuid: 17ff551f-a037-4c0a-a0cb-ad6616ab3aa3
weight: -1
- _links:
dismiss:
href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss
follow:
href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow
self:
href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2
body: null
expire_at: '2019-07-15T09:45:00-04:00'
filters:
display_mode: bar
paths: []
type: alert
flags:
active: true
dismissed: false
dismissible: true
id: 883581
start_at: '2019-07-07T09:45:00-04:00'
title: Another example title
url: null
uuid: 17ff551f-a037-4c0a-a0cb-ad6616ab3aa3
weight: -1
_links:
filter:
href: https://cloud.acquia.com/api/messages{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/messages{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/messages{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/
self:
href: https://cloud.acquia.com/api/messages
sort:
href: https://cloud.acquia.com/api/messages{?sort}
templated: true
pagination:
limit: 2
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_ux-messages'
description: OK
'404':
content:
application/hal+json:
examples:
Messages not found:
value:
error: not_found
message: The messages you are trying to view do not exist, or you do not have permission to access them.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-account-api-openapi.yml