Acquia Applications API
The Applications API from Acquia — 36 operation(s) for applications.
Operations 47
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/applications
List the applications I can access · Return a list of applications the current user has access to
#
Ask an LLM
“Which Acquia applications do I have access to through my teams?”
“Can I page through all of my Cloud Platform applications sorted by name?”
Tell an agent
List every application I have access to.
Show my applications matching {filter}, {limit} at a time.
GET
/applications/{applicationUuid}
Get details of one application · Return details about a specific application
#
Ask an LLM
“What details can I see about a single hosted application?”
“How do I look up one application by its UUID?”
Tell an agent
Show me the details of application {applicationUuid}.
Fetch the record for application {applicationUuid}.
Ask an LLM
“Can I change the display name of an existing application?”
“How do I rename one of my hosted applications?”
Tell an agent
Rename application {applicationUuid} to {name}.
Give application {applicationUuid} the new name {name}.
GET
/applications/{applicationUuid}/artifacts
List build artifacts for a Node.js application · Return application artifacts
#
Ask an LLM
“Where can I see the build artifacts produced for my Node.js application?”
“Can I sort a Node.js app's build artifacts by creation date?”
Tell an agent
List the build artifacts for application {applicationUuid}.
Show build artifacts of application {applicationUuid} sorted by {sort}.
GET
/applications/{applicationUuid}/artifacts/{artifactId}
Get one build artifact of an application · Return details about a specific artifact
#
Ask an LLM
“What information is kept about a single build artifact?”
“Can I inspect one specific artifact from a Node.js app build?”
Tell an agent
Show build artifact {artifactId} of application {applicationUuid}.
Get the details of artifact {artifactId} in application {applicationUuid}.
GET
/applications/{applicationUuid}/code
List an application's branches and release tags · Return application branches and release tags
#
Ask an LLM
“Which git branches and release tags exist in my application's repository?”
“Can I filter my application's branches and tags by name?”
Tell an agent
List the branches and tags in application {applicationUuid}'s repository.
Find branches or tags in application {applicationUuid} matching {filter}.
GET
/applications/{applicationUuid}/code-studio
Get an application's Code Studio project · Returns details about the Code Studio project for an application
#
Ask an LLM
“Does my application already have a Code Studio project set up?”
“What does the Code Studio project for an application look like?”
Tell an agent
Show the Code Studio project for application {applicationUuid}.
Check the Code Studio project details of application {applicationUuid}.
POST
/applications/{applicationUuid}/code-studio
Create a Code Studio project for an application · Creates the Code Studio project for an application
#
Ask an LLM
“How do I set up Code Studio for one of my applications?”
“Can I create a Code Studio project for an application that doesn't have one?”
Tell an agent
Create a Code Studio project for application {applicationUuid}.
Set up Code Studio on application {applicationUuid}.
DELETE
/applications/{applicationUuid}/code-studio
Remove an application's Code Studio project · Removes the Code Studio project from an application
#
Ask an LLM
“Can I remove Code Studio from an application I no longer build there?”
“What happens when I take the Code Studio project off an application?”
Tell an agent destructive · confirm first
Remove the Code Studio project from application {applicationUuid}.
Tear down Code Studio for application {applicationUuid}.
GET
/applications/{applicationUuid}/databases
List an application's database names · Returns a list database names for the application
#
Ask an LLM
“What databases does my application have?”
“Can I filter an application's database list by name?”
Tell an agent
List the database names for application {applicationUuid}.
Show databases in application {applicationUuid} matching {filter}.
POST
/applications/{applicationUuid}/databases
Create a database across all environments · Creates a database
#
Ask an LLM
“How do I add a new database to every environment of my application?”
“Does creating a database add it to dev, stage and prod at once?”
Tell an agent
Create a database named {name} in application {applicationUuid}.
Add database {name} to all environments of application {applicationUuid}.
DELETE
/applications/{applicationUuid}/databases/{name}
Drop a database from every environment · Drops (deletes) a database
#
Ask an LLM
“Can I drop a database entirely from my application?”
“Will deleting a database remove it from all environments, not just one?”
Tell an agent destructive · confirm first
Drop database {name} from application {applicationUuid}.
Delete the {name} database in every environment of application {applicationUuid}.
POST
/applications/{applicationUuid}/databases/{name}/actions/erase
Truncate all tables in a database · Erases (truncates) a database
#
Ask an LLM
“How can I wipe every table in a database but keep the database itself?”
“Does erasing a database clear its tables in all environments?”
Tell an agent destructive · confirm first
Erase all tables in database {name} of application {applicationUuid}.
Truncate the {name} database across application {applicationUuid}'s environments.
GET
/applications/{applicationUuid}/email/domains
List email domains available to an application · Returns a list of email domains associated with the application
#
Ask an LLM
“Which email sending domains are associated with my application?”
“Can I see the subscription-verified email domains my app could use?”
Tell an agent
List the email domains for application {applicationUuid}.
Show email domains of application {applicationUuid} matching {filter}.
POST
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate
Associate an email domain with an application · Associates an email domain with an Application
#
Ask an LLM
“How do I let my application send email from a registered domain?”
“Can I attach a verified email domain to a specific application?”
Tell an agent
Associate email domain {domainRegistrationUuid} with application {applicationUuid}.
Link domain registration {domainRegistrationUuid} to application {applicationUuid} for Platform Email.
POST
/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate
Detach an email domain from an application · Disassociates an email domain with an Application
#
Ask an LLM
“Can I stop an application from using a particular email domain?”
“How do I unlink an email domain from one of my apps?”
Tell an agent
Disassociate email domain {domainRegistrationUuid} from application {applicationUuid}.
Unlink domain registration {domainRegistrationUuid} from application {applicationUuid}.
GET
/applications/{applicationUuid}/ides
List Cloud IDEs for an application · Returns a list of Cloud IDEs associated with this application
#
Ask an LLM
“Which Cloud IDEs have been created for this application?”
“Who on my team has a Cloud IDE tied to this app?”
Tell an agent
List the Cloud IDEs attached to application {applicationUuid}.
Show all IDEs provisioned for application {applicationUuid}.
POST
/applications/{applicationUuid}/ides
Create a Cloud IDE for an application · Creates a new Cloud IDE
#
Ask an LLM
“How do I spin up a new Cloud IDE for my application?”
“Can I give a new Cloud IDE a custom label?”
Tell an agent
Create a Cloud IDE labeled {label} for application {applicationUuid}.
Provision a new IDE called {label} on application {applicationUuid}.
GET
/applications/{applicationUuid}/messages
List in-product messages for an application · Returns a list of messages associated with this application
#
Ask an LLM
“What platform messages have been posted about my application?”
“Can I filter an application's messages by message type or display mode?”
Tell an agent
List the messages for application {applicationUuid}.
Show application {applicationUuid} messages between {from} and {to}.
GET
/applications/{applicationUuid}/notifications
List work notifications for an application · Returns a list of notifications associated with this application by its UUID
#
Ask an LLM
“What recent operations have been started on my application?”
“Can I check the status of work items someone kicked off on an application?”
Tell an agent
List notifications for application {applicationUuid}.
Show the latest {limit} notifications on application {applicationUuid}.
GET
/applications/{applicationUuid}/permissions
List my permissions on an application · Returns a list of permissions the user has for this application by its UUID
#
Ask an LLM
“What am I allowed to do on this application?”
“Which permissions do I hold for a given app?”
Tell an agent
List my permissions on application {applicationUuid}.
Show every permission I have for application {applicationUuid}.
GET
/applications/{applicationUuid}/search
Get the search entry point for an application · Returns a traversal endpoint for search entities for the application
#
Ask an LLM
“Where do the search-related endpoints for an application start?”
“Is there a root link that leads to an application's search resources?”
Tell an agent
Get the search traversal links for application {applicationUuid}.
Open the search root endpoint of application {applicationUuid}.
GET
/applications/{applicationUuid}/search/config-sets
List search configuration sets for an application · Returns a collection of search configuration sets for an application
#
Ask an LLM
“Which search configuration sets does my application have?”
“Can I see all the Solr config sets uploaded for an app?”
Tell an agent
List search configuration sets for application {applicationUuid}.
Show every search config set on application {applicationUuid}.
POST
/applications/{applicationUuid}/search/config-sets
Upload a search configuration set · Creates a search configuration set for an application
#
Ask an LLM
“How do I add a custom search configuration set to my application?”
“Can I upload a search config archive for an app?”
Tell an agent
Create a search configuration set on application {applicationUuid} from archive {archive}.
Upload config archive {archive} as a new search config set for application {applicationUuid}.
GET
/applications/{applicationUuid}/search/config-sets/{configurationSetId}
Get one search configuration set · Returns a search configuration set for an application
#
Ask an LLM
“What's inside a specific search configuration set?”
“Can I look up a single search config set by its ID?”
Tell an agent
Show search configuration set {configurationSetId} for application {applicationUuid}.
Get config set {configurationSetId} from application {applicationUuid}.
DELETE
/applications/{applicationUuid}/search/config-sets/{configurationSetId}
Delete a search configuration set · Removes and deletes a specific search configuration set from an application
#
Ask an LLM
“Can I remove a search configuration set I no longer use?”
“How do I delete an old search config set from an application?”
Tell an agent destructive · confirm first
Delete search configuration set {configurationSetId} from application {applicationUuid}.
Remove config set {configurationSetId} on application {applicationUuid}.
GET
/applications/{applicationUuid}/settings
Get the settings entry point for an application · Returns available settings for this application
#
Ask an LLM
“What settings groups are available for an application?”
“Is there a root link to navigate an application's settings sections?”
Tell an agent
Get the settings traversal links for application {applicationUuid}.
Show which settings groups application {applicationUuid} exposes.
GET
/applications/{applicationUuid}/settings/hosting
Get an application's hosting settings · Returns the hosting settings for this application
#
Ask an LLM
“What hosting settings are configured for my application?”
“Where can I check an app's hosting configuration?”
Tell an agent
Show the hosting settings of application {applicationUuid}.
Get hosting configuration for application {applicationUuid}.
GET
/applications/{applicationUuid}/settings/keys
Get an application's legacy product keys · Returns the legacy product keys for this application
#
Ask an LLM
“Where do I find the legacy product keys for an application?”
“Can I retrieve the old-style product keys tied to my app?”
Tell an agent
Show the legacy product keys for application {applicationUuid}.
Get application {applicationUuid}'s legacy keys.
GET
/applications/{applicationUuid}/settings/ra
Get remote administration settings · Returns the remote administration settings for this application
#
Ask an LLM
“How is Remote Administration currently configured for my application?”
“What update mode is my app's remote administration set to?”
Tell an agent
Show the remote administration settings of application {applicationUuid}.
Check the RA update configuration for application {applicationUuid}.
PUT
/applications/{applicationUuid}/settings/ra
Change remote administration settings · Modifies the remote administration settings for an application
#
Ask an LLM
“Can I pause Remote Administration updates until a certain date?”
“How do I set which environment RA deploys updates to and whether it copies the database?”
Tell an agent
Set remote administration for application {applicationUuid} to update mode {update_mode}.
Pause RA updates on application {applicationUuid} until {pause_until}, keeping mode {update_mode}.
GET
/applications/{applicationUuid}/settings/security
Get an application's security policy · Returns the security policy settings for this application
#
Ask an LLM
“Is two-factor authentication required on my application?”
“Which IP addresses are allowed by an app's security policy?”
Tell an agent
Show the security policy settings of application {applicationUuid}.
Check the allowed IPs and 2FA setting for application {applicationUuid}.
PUT
/applications/{applicationUuid}/settings/security
Update an application's security policy · Modifies the security policy settings for an application
#
Ask an LLM
“Can I require two-factor authentication for everyone on an application?”
“How do I restrict an application to a list of allowed IP addresses?”
Tell an agent
Require 2FA on application {applicationUuid}: set tfa_required to {tfa_required}.
Limit application {applicationUuid} access to IPs {allowed_ips}.
GET
/applications/{applicationUuid}/tags
List an application's tags · Returns a list of application tags associated with this application
#
Ask an LLM
“What tags have been applied to my application?”
“Can I see the colored labels on an app?”
Tell an agent
List the tags on application {applicationUuid}.
Show application {applicationUuid}'s tags and colors.
POST
/applications/{applicationUuid}/tags
Add a tag to an application · Creates a new application tag
#
Ask an LLM
“How do I label an application with a colored tag?”
“Can I pick the color when tagging an app?”
Tell an agent
Tag application {applicationUuid} with {name} in {color}.
Create a {color} tag called {name} on application {applicationUuid}.
DELETE
/applications/{applicationUuid}/tags/{tagName}
Remove a tag from an application · Deletes an application tag
#
Ask an LLM
“Can I delete a tag I put on an application by mistake?”
“How do I take a label off an app?”
Tell an agent destructive · confirm first
Delete tag {tagName} from application {applicationUuid}.
Remove the {tagName} label on application {applicationUuid}.
GET
/applications/{applicationUuid}/tasks
List tasks run on an application · Returns a list of tasks associated with this application by its UUID
#
Ask an LLM
“What tasks have been run against my application recently?”
“Can I filter an application's task history?”
Tell an agent
List the tasks for application {applicationUuid}.
Show application {applicationUuid} tasks matching {filter}.
GET
/applications/{applicationUuid}/teams
List teams with access to an application · Returns a list of teams associated with this application
#
Ask an LLM
“Which teams have access to this application?”
“Can I search an app's teams by name?”
Tell an agent
List the teams assigned to application {applicationUuid}.
Find teams on application {applicationUuid} matching {filter}.
GET
/applications/{applicationUuid}/metrics/usage
Get usage metric links for an application · Retrieves traversal links for detailed metrics on usage (views and visits) of…
#
Ask an LLM
“Where do I start to explore an application's views and visits metrics?”
“What usage metric endpoints are available for one app?”
Tell an agent
Get the usage metric links for application {applicationUuid}.
Show which usage reports exist for application {applicationUuid}.
GET
/applications/{applicationUuid}/metrics/usage/data
Get aggregate usage data for an application · Retrieves aggregate usage data for an application, filterable by views or…
#
Ask an LLM
“How much traffic did my application get overall?”
“Can I pull aggregate views or visits for an app at a daily resolution?”
Tell an agent
Get aggregate usage data for application {applicationUuid}.
Show application {applicationUuid} usage filtered by {filter} at {resolution} resolution.
GET
/applications/{applicationUuid}/metrics/usage/data-by-environment
Get application usage broken down by environment · Retrieves usage data (views or visits) for an application, broken down by…
#
Ask an LLM
“Which environment of my application gets the most traffic?”
“Can I compare usage across an app's environments side by side?”
Tell an agent
Break down usage for application {applicationUuid} by environment.
Show per-environment usage for application {applicationUuid} with filter {filter}.
GET
/applications/{applicationUuid}/metrics/usage/{usageMetric}
Get one usage metric for an application · Retrieves aggregate usage metric data (views or visits) for an application
#
Ask an LLM
“What is the total for a single metric like visits on my app?”
“Can I request just views or just visits for an application?”
Tell an agent
Get the {usageMetric} metric for application {applicationUuid}.
Show aggregate {usageMetric} for application {applicationUuid} filtered by {filter}.
GET
/applications/{applicationUuid}/metrics/usage/views-by-environment
Get application page views per environment · Retrieves views data for an application, broken down by environment
#
Ask an LLM
“How many page views does each environment of my app get?”
“Can I see views only, split by environment?”
Tell an agent
Show page views per environment for application {applicationUuid}.
Get views by environment for application {applicationUuid} at {resolution} resolution.
GET
/applications/{applicationUuid}/metrics/usage/visits-by-environment
Get application visits per environment · Retrieves visits data for an application, broken down by environment
#
Ask an LLM
“How many visits does each of my app's environments receive?”
“Can I see visits only, split by environment?”
Tell an agent
Show visits per environment for application {applicationUuid}.
Get visits by environment for application {applicationUuid} at {resolution} resolution.
GET
/applications/{applicationUuid}/environments
List an application's environments · Returns a list of environments within this application by its UUID
#
Ask an LLM
“What environments does my application have?”
“Can I filter an app's environments list?”
Tell an agent
List the environments in application {applicationUuid}.
Show environments of application {applicationUuid} matching {filter}.
POST
/applications/{applicationUuid}/environments
Add a continuous delivery environment · Add a new continuous delivery environment to an application by the application…
#
Ask an LLM
“How do I add a new CD environment to my application?”
“Can a new continuous delivery environment track a specific branch?”
Tell an agent
Add CD environment {label} on branch {branch} with databases {databases} to application {applicationUuid}.
Create a continuous delivery environment {label} from branch {branch} in application {applicationUuid}, using databases {databases}.
GET
/applications/{applicationUuid}/features
List an application's feature flags · Return application features
#
Ask an LLM
“Which feature flags are turned on for my application?”
“What features are enabled on an app?”
Tell an agent
List the feature flags for application {applicationUuid}.
Show enabled features on application {applicationUuid}.