Acquia Applications API
The Applications API from Acquia — 36 operation(s) for applications.
Acquia Applications API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Applications. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 47 operations across 36 paths, and defines 68 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
47 operations
36 paths
68 schemas
4 DELETE31 GET9 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Acquia Applications API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow.
An API key is passed in the header as Authorization (Codebase_Service_JWT).
An API key is passed in the header as Authorization (MEO_Environment_Service_JWT).
An API key is passed in the header as Authorization (Site_Service_JWT).
Acquia_Cloud_API_Documentation_OAuth2— 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…Codebase_Service_JWT— Value for the Authorization header parameter.MEO_Environment_Service_JWT— Value for the Authorization header parameter.Site_Service_JWT— Value for the Authorization header parameter.
Paths & Operations 47
Across 36 paths, the API surfaces 47 operations — 4 DELETE, 31 GET, 9 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Applications 47
GET
/applications
Acquia Return a List of Applications the Current User Has Access To.
GET
/applications/{applicationUuid}
Acquia Return Details About a Specific Application.
PUT
/applications/{applicationUuid}
Acquia Renames an Application.
GET
/applications/{applicationUuid}/artifacts
Acquia Return Application Artifacts.
GET
/applications/{applicationUuid}/artifacts/{artifactId}
Acquia Return Details About a Specific Artifact.
GET
/applications/{applicationUuid}/code
Acquia Return Application Branches and Release Tags.
DELETE
/applications/{applicationUuid}/code-studio
Acquia Removes the Code Studio Project from an Application.
GET
/applications/{applicationUuid}/code-studio
Acquia Returns Details About the Code Studio Project for an Application.
POST
/applications/{applicationUuid}/code-studio
Acquia Creates the Code Studio Project for an Application.
GET
/applications/{applicationUuid}/databases
Acquia Returns a List Database Names for the Application.
POST
/applications/{applicationUuid}/databases
Acquia Creates a Database.
DELETE
/applications/{applicationUuid}/databases/{name}
Acquia Drops (deletes) a Database.
POST
/applications/{applicationUuid}/databases/{name}/actions/erase
Acquia Erases (truncates) a Database.
GET
/applications/{applicationUuid}/email/domains
Acquia Returns a List of Email Domains Associated with the Application.
POST
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate
Acquia Associates an Email Domain with an Application.
POST
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate
Acquia Disassociates an Email Domain with an Application.
GET
/applications/{applicationUuid}/environments
Acquia Returns a List of Environments Within This Application by its UUID.
POST
/applications/{applicationUuid}/environments
Acquia Add a New Continuous Delivery Environment to an Application by the Application UUID.
GET
/applications/{applicationUuid}/features
Acquia Return Application Features.
GET
/applications/{applicationUuid}/ides
Acquia Returns a List of Cloud IDEs Associated with This Application.
POST
/applications/{applicationUuid}/ides
Acquia Creates a New Cloud IDE.
GET
/applications/{applicationUuid}/messages
Acquia Returns a List of Messages Associated with This Application.
GET
/applications/{applicationUuid}/metrics/usage
Acquia Retrieves Traversal Links for Detailed Metrics on Usage (views and Visits) of Your Application.
GET
/applications/{applicationUuid}/metrics/usage/data
Acquia Retrieves Aggregate Usage Data for an Application, Filterable by Views or Visits and by Environment.
GET
/applications/{applicationUuid}/metrics/usage/data-by-environment
Acquia Retrieves Usage Data (views or Visits) for an Application, Broken Down by Environment.
GET
/applications/{applicationUuid}/metrics/usage/views-by-environment
Acquia Retrieves Views Data for an Application, Broken Down by Environment.
GET
/applications/{applicationUuid}/metrics/usage/visits-by-environment
Acquia Retrieves Visits Data for an Application, Broken Down by Environment.
GET
/applications/{applicationUuid}/metrics/usage/{usageMetric}
Acquia Retrieves Aggregate Usage Metric Data (views or Visits) for an Application..
GET
/applications/{applicationUuid}/notifications
Acquia Returns a List of Notifications Associated with This Application by its UUID.
GET
/applications/{applicationUuid}/permissions
Acquia Returns a List of Permissions the User Has for This Application by its UUID.
GET
/applications/{applicationUuid}/search
Acquia Returns a Traversal Endpoint for Search Entities for the Application.
GET
/applications/{applicationUuid}/search/config-sets
Acquia Returns a Collection of Search Configuration Sets for an Application
POST
/applications/{applicationUuid}/search/config-sets
Acquia Creates a Search Configuration Set for an Application.
DELETE
/applications/{applicationUuid}/search/config-sets/{configurationSetId}
Acquia Removes and Deletes a Specific Search Configuration Set from an Application.
GET
/applications/{applicationUuid}/search/config-sets/{configurationSetId}
Acquia Returns a Search Configuration Set for an Application
GET
/applications/{applicationUuid}/settings
Acquia Returns Available Settings for This Application.
GET
/applications/{applicationUuid}/settings/hostingdeprecated
Acquia Returns the Hosting Settings for This Application.
GET
/applications/{applicationUuid}/settings/keysdeprecated
Acquia Returns the Legacy Product Keys for This Application.
GET
/applications/{applicationUuid}/settings/ra
Acquia Returns the Remote Administration Settings for This Application.
PUT
/applications/{applicationUuid}/settings/ra
Acquia Modifies the Remote Administration Settings for an Application.
GET
/applications/{applicationUuid}/settings/securitydeprecated
Acquia Returns the Security Policy Settings for This Application.
PUT
/applications/{applicationUuid}/settings/securitydeprecated
Acquia Modifies the Security Policy Settings for an Application.
GET
/applications/{applicationUuid}/tags
Acquia Returns a List of Application Tags Associated with This Application.
POST
/applications/{applicationUuid}/tags
Acquia Creates a New Application Tag.
DELETE
/applications/{applicationUuid}/tags/{tagName}
Acquia Deletes an Application Tag.
GET
/applications/{applicationUuid}/tasks
Acquia Returns a List of Tasks Associated with This Application by its UUID.
GET
/applications/{applicationUuid}/teams
Acquia Returns a List of Teams Associated with This Application.
Schemas 68
The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_environment (22 properties), Acquia_Cloud_API_Documentation_task (15 properties), Acquia_Cloud_API_Documentation_environment-flags (14 properties), Acquia_Cloud_API_Documentation_environment-configuration (12 properties). Each schema is shown below with its type and property counts.
Acquia_Cloud_API_Documentation_permission
object
5 properties
5 required
Acquia_Cloud_API_Documentation_code-studio-project
object
The model for a Code Studio project.
4 properties
4 required
Acquia_Cloud_API_Documentation_ux-messages
object
3 properties
3 required
Acquia_Cloud_API_Documentation_configuration-set
object
An Acquia Search configuration set.
7 properties
6 required
Acquia_Cloud_API_Documentation_application
object
11 properties
11 required
Acquia_Cloud_API_Documentation_artifact
object
5 properties
5 required
Acquia_Cloud_API_Documentation_remote-administration-settings
object
10 properties
Acquia_Cloud_API_Documentation_application-flags
object
An array of various flags that indicate functionality associated with applications.
1 property
Acquia_Cloud_API_Documentation_application-metadata
object
Application metadata.
1 property
Acquia_Cloud_API_Documentation_security-settings
object
4 properties
Acquia_Cloud_API_Documentation_resource-tag-embedded
object
An associated tag.
3 properties
3 required
Acquia_Cloud_API_Documentation_artifact-stub
object
2 properties
2 required
Acquia_Cloud_API_Documentation_applications
object
3 properties
Acquia_Cloud_API_Documentation_subscription-stub
object
The subscription this application belongs to.
2 properties
2 required
Acquia_Cloud_API_Documentation_search
object
A collection of links that provides traversal of search endpoints.
1 property
1 required
Acquia_Cloud_API_Documentation_usage
object
A collection of traversal links for an entity.
1 property
1 required
Acquia_Cloud_API_Documentation_applications-tasks
object
3 properties
3 required
Acquia_Cloud_API_Documentation_email-domain
object
The Email Domain
4 properties
4 required
Acquia_Cloud_API_Documentation_message
object
1 property
1 required
Acquia_Cloud_API_Documentation_applications-teams
object
3 properties
3 required
Acquia_Cloud_API_Documentation_ides
object
3 properties
3 required
Acquia_Cloud_API_Documentation_environments
object
3 properties
3 required
Acquia_Cloud_API_Documentation_ux-message-flags
object
An array of various flags associated with a message.
3 properties
Acquia_Cloud_API_Documentation_hosting-settings
object
4 properties
Acquia_Cloud_API_Documentation_application-usage-metrics
object
A collection of application usage metrics.
3 properties
3 required
Acquia_Cloud_API_Documentation_application-feature
object
3 properties
3 required
Acquia_Cloud_API_Documentation_user-stub
object
6 properties
6 required
Acquia_Cloud_API_Documentation_environment-flags
object
An array of various flags that indicate functionality associated with the environment.
14 properties
Acquia_Cloud_API_Documentation_application-databases
object
Collection of application databases.
3 properties
3 required
Acquia_Cloud_API_Documentation_team
object
6 properties
6 required
Acquia_Cloud_API_Documentation_application-database-name
object
Application database name.
1 property
1 required
Acquia_Cloud_API_Documentation_legacy-product-keys-settings
object
3 properties
Acquia_Cloud_API_Documentation_organization-stub-embedded
object
A related organization.
3 properties
2 required
Acquia_Cloud_API_Documentation_remote-administration
object
10 properties
1 required
Acquia_Cloud_API_Documentation_settings
object
1 property
Acquia_Cloud_API_Documentation_ux-message
object
11 properties
11 required
Acquia_Cloud_API_Documentation_vcs
object
3 properties
3 required
Acquia_Cloud_API_Documentation_application-no-embedded
object
10 properties
10 required
Acquia_Cloud_API_Documentation_application-features
object
3 properties
Acquia_Cloud_API_Documentation_environment-metadata
object
Environment metadata.
1 property
Acquia_Cloud_API_Documentation_configuration-sets
object
A collection of configuration sets.
4 properties
Acquia_Cloud_API_Documentation_message-with-links
object
2 properties
2 required
Acquia_Cloud_API_Documentation_organization-stub
object
2 properties
2 required
Acquia_Cloud_API_Documentation_code-flags
object
An array of various flags that indicate functionality associated with code branches and tags on applications.
1 property
Acquia_Cloud_API_Documentation_applications-notifications
object
3 properties
3 required
Acquia_Cloud_API_Documentation_subscription-metadata
object
Subscription metadata.
1 property
Acquia_Cloud_API_Documentation_notification-stub
object
A notification about an event or a task.
11 properties
10 required
Acquia_Cloud_API_Documentation_code
object
3 properties
Acquia_Cloud_API_Documentation_application-stub
object
2 properties
2 required
Acquia_Cloud_API_Documentation_applications-permissions
object
4 properties
4 required
Acquia_Cloud_API_Documentation_application-usage-metric
object
Provides details about views and visits for an application.
5 properties
4 required
Acquia_Cloud_API_Documentation_subscription-stub-embedded
object
A related subscription.
3 properties
3 required
Acquia_Cloud_API_Documentation_artifacts
object
3 properties
Acquia_Cloud_API_Documentation_pagination
object
A collection of pagination properties.
3 properties
Acquia_Cloud_API_Documentation_permission-flags
object
An array of various flags regarding the status of the permission.
1 property
Acquia_Cloud_API_Documentation_user-profile
object
A user profile.
8 properties
8 required
Acquia_Cloud_API_Documentation_environment-configuration
object
An array of configuration details for the environment.
12 properties
Acquia_Cloud_API_Documentation_validation-error
object
A validation error.
2 properties
2 required
Acquia_Cloud_API_Documentation_health
object
The current health for this resource.
3 properties
Acquia_Cloud_API_Documentation_resource-tags
object
3 properties
3 required
Acquia_Cloud_API_Documentation_email-domains
object
4 properties
Acquia_Cloud_API_Documentation_ide
object
5 properties
4 required
Acquia_Cloud_API_Documentation_resource-tag
object
4 properties
4 required
Acquia_Cloud_API_Documentation_ux-message-filters
object
Defines where a message should appear.
3 properties
Acquia_Cloud_API_Documentation_environment
object
22 properties
22 required
Acquia_Cloud_API_Documentation_error
object
2 properties
2 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property
1 required
Acquia_Cloud_API_Documentation_task
object
15 properties
14 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Acquia 12
Other APIs Acquia publishes across the network.
Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Account API
Acquia Agreements API
Acquia Application Performance Monitoring Services API
Acquia Cloud IDE API
Acquia Codebases API
Acquia Current system health API
Acquia Distributions API
Acquia Email API
Acquia Environments API
Acquia Identity Providers API
#Applications