Acquia

Acquia Subscriptions API

The Subscriptions API from Acquia — 22 operation(s) for subscriptions.

GitHub OpenAPI

Operations 31

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 /subscriptions List my subscriptions · Return a list of subscription #
Ask an LLM
“Which Acquia subscriptions do I belong to?”
“Can I page through all of my subscriptions?”
Tell an agent
List all of my subscriptions.
Show subscriptions matching {filter}.
GET /subscriptions/{subscriptionUuid} Get details of a subscription · Return details about a specific subscription #
Ask an LLM
“What details are stored on a single subscription?”
“Can I look up one subscription by its UUID?”
Tell an agent
Show subscription {subscriptionUuid}.
Get the details of subscription {subscriptionUuid}.
PUT /subscriptions/{subscriptionUuid} Rename a subscription · Modifies a subscription #
Ask an LLM
“Can I change the name of a subscription?”
“How do I rename my subscription?”
Tell an agent
Rename subscription {subscriptionUuid} to {name}.
Set the name of subscription {subscriptionUuid} to {name}.
GET /subscriptions/{subscriptionUuid}/applications List applications in a subscription · Provides a list of applications that are a part of the subscription #
Ask an LLM
“Which applications are part of this subscription?”
“Can I filter the apps that belong to a subscription?”
Tell an agent
List applications in subscription {subscriptionUuid}.
Show subscription {subscriptionUuid} applications matching {filter}.
GET /subscriptions/{subscriptionUuid}/code-studio Get Code Studio metadata for a subscription · Retrieves Code Studio metadata for a subscription #
Ask an LLM
“Is Code Studio provisioned on my subscription?”
“What Code Studio details are recorded for a subscription?”
Tell an agent
Show Code Studio metadata for subscription {subscriptionUuid}.
Get the Code Studio status of subscription {subscriptionUuid}.
OPTIONS /subscriptions/{subscriptionUuid}/code-studio Show Code Studio options for a subscription · Displays Code Studio options for a subscription #
Ask an LLM
“What Code Studio options are available on my subscription?”
“Which actions does the subscription Code Studio resource allow?”
Tell an agent
Display the Code Studio options for subscription {subscriptionUuid}.
Check which Code Studio operations subscription {subscriptionUuid} supports.
POST /subscriptions/{subscriptionUuid}/code-studio/actions/enable Enable Code Studio on a subscription · Enables Code Studio for a subscription #
Ask an LLM
“How do I turn on Code Studio for my whole subscription?”
“Can I provision Code Studio at the subscription level?”
Tell an agent
Enable Code Studio for subscription {subscriptionUuid}.
Provision Code Studio on subscription {subscriptionUuid}.
GET /subscriptions/{subscriptionUuid}/code-studio/applications List Code Studio-enabled applications · Retrieves a list of Code Studio enabled applications for a subscription #
Ask an LLM
“Which of my subscription's applications use Code Studio?”
“Can I see only the apps with Code Studio turned on?”
Tell an agent
List Code Studio-enabled applications in subscription {subscriptionUuid}.
Show which apps in subscription {subscriptionUuid} have Code Studio.
GET /subscriptions/{subscriptionUuid}/code-studio/users List users holding Code Studio seats · Retrieves a list of users assigned to Code Studio for a subscription #
Ask an LLM
“Who is using a Code Studio seat on my subscription?”
“How many Code Studio seats are assigned right now?”
Tell an agent
List Code Studio users for subscription {subscriptionUuid}.
Show everyone assigned a Code Studio seat in subscription {subscriptionUuid}.
POST /subscriptions/{subscriptionUuid}/code-studio/users Assign a user a Code Studio seat · Assigns a user to a Code Studio seat for a subscription #
Ask an LLM
“How do I give a teammate a Code Studio seat?”
“Can I assign a role when adding someone to Code Studio?”
Tell an agent
Assign user {user_id} a Code Studio seat in subscription {subscriptionUuid}.
Add {user_id} to Code Studio on subscription {subscriptionUuid} with role {role}.
GET /subscriptions/{subscriptionUuid}/code-studio/users/{userUuid} Get one Code Studio user · Retrieves details about a specific Code Studio user #
Ask an LLM
“What role does a particular person have in Code Studio?”
“Can I check the seat details for one Code Studio user?”
Tell an agent
Show Code Studio user {userUuid} in subscription {subscriptionUuid}.
Get the Code Studio seat details for {userUuid} on subscription {subscriptionUuid}.
DELETE /subscriptions/{subscriptionUuid}/code-studio/users/{userUuid} Unassign a user's Code Studio seat · Unassigns a user from a Code Studio seat #
Ask an LLM
“Can I free up a Code Studio seat from someone who left?”
“How do I remove a person from Code Studio?”
Tell an agent destructive · confirm first
Unassign {userUuid} from Code Studio in subscription {subscriptionUuid}.
Release the Code Studio seat held by {userUuid} on subscription {subscriptionUuid}.
GET /subscriptions/{subscriptionUuid}/domains List domains registered to a subscription · Returns a list of Domains registered with this subscription #
Ask an LLM
“Which email domains are registered on my subscription?”
“Can I filter a subscription's registered domains?”
Tell an agent
List domains registered with subscription {subscriptionUuid}.
Show registered domains in subscription {subscriptionUuid} matching {filter}.
POST /subscriptions/{subscriptionUuid}/domains Register a domain with a subscription · Registers a Domain with this subscription #
Ask an LLM
“How do I register a new sending domain on my subscription?”
“Can I add my company domain to a subscription for Platform Email?”
Tell an agent
Register domain {domain} with subscription {subscriptionUuid}.
Add {domain} as a registered domain on subscription {subscriptionUuid}.
GET /subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid} Get one registered domain · Returns a speicific Domain registered with this subscription #
Ask an LLM
“What is the verification status of a domain I registered?”
“Can I see the DNS details for one registered domain?”
Tell an agent
Show domain registration {domainRegistrationUuid} on subscription {subscriptionUuid}.
Get details of registered domain {domainRegistrationUuid} in subscription {subscriptionUuid}.
DELETE /subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid} Unregister a domain from a subscription · Unregisters a Domain registered with this subscription #
Ask an LLM
“Can I remove a domain I registered on my subscription?”
“How do I unregister an email domain?”
Tell an agent destructive · confirm first
Unregister domain {domainRegistrationUuid} from subscription {subscriptionUuid}.
Delete domain registration {domainRegistrationUuid} on subscription {subscriptionUuid}.
POST /subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify Re-verify a registered domain · Triggers re-verification and update to the domain verification status #
Ask an LLM
“I've updated my DNS records; how do I get the domain re-checked?”
“Can I trigger a fresh verification of a registered domain?”
Tell an agent
Re-verify domain {domainRegistrationUuid} on subscription {subscriptionUuid}.
Refresh the verification status of domain registration {domainRegistrationUuid} in subscription {subscriptionUuid}.
GET /subscriptions/{subscriptionUuid}/entitlements List a subscription's entitlements · Provides a list of entitlements that are a part of the subscription #
Ask an LLM
“What products and limits am I entitled to on my subscription?”
“Which entitlements come with a subscription?”
Tell an agent
List the entitlements of subscription {subscriptionUuid}.
Show what subscription {subscriptionUuid} is entitled to.
GET /subscriptions/{subscriptionUuid}/ides List Cloud IDEs in a subscription · Returns a list of Cloud IDEs associated with this subscription #
Ask an LLM
“How many Cloud IDEs exist across my subscription?”
“Which Cloud IDEs are tied to a subscription?”
Tell an agent
List Cloud IDEs across subscription {subscriptionUuid}.
Show every IDE provisioned under subscription {subscriptionUuid}.
GET /subscriptions/{subscriptionUuid}/metrics/usage/data Get aggregate usage data for a subscription · Retrieves aggregate usage data for a subscription #
Ask an LLM
“How much total traffic did my subscription use this period?”
“Can I filter subscription usage by date range and metric?”
Tell an agent
Get aggregate usage for subscription {subscriptionUuid}.
Show subscription {subscriptionUuid} usage filtered by {filter} at {resolution} resolution.
GET /subscriptions/{subscriptionUuid}/metrics/usage/data-by-application Get subscription usage broken down by application · Retrieves usage data for a subscription, broken down by application #
Ask an LLM
“Which application consumes the most of my subscription's traffic?”
“Can I compare usage across apps in a subscription?”
Tell an agent
Break down usage for subscription {subscriptionUuid} by application.
Show per-application usage in subscription {subscriptionUuid} with filter {filter}.
GET /subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric} Get one usage metric for a subscription · Retrieves aggregate usage metric data for a subscription #
Ask an LLM
“What is my subscription's total for just visits or just views?”
“Can I pull a single metric across the whole subscription?”
Tell an agent
Get the {usageMetric} metric for subscription {subscriptionUuid}.
Show aggregate {usageMetric} for subscription {subscriptionUuid} filtered by {filter}.
GET /subscriptions/{subscriptionUuid}/metrics/usage/views-by-application Get subscription page views per application · Retrieves views data for a subscription, broken down by application #
Ask an LLM
“How many page views does each application in my subscription get?”
“Can I see views only, split by app?”
Tell an agent
Show page views per application for subscription {subscriptionUuid}.
Get views by application in subscription {subscriptionUuid} at {resolution} resolution.
GET /subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application Get subscription visits per application · Retrieves visits data for a subscription, broken down by application #
Ask an LLM
“How many visits does each app in my subscription receive?”
“Can I see visits only, split by application?”
Tell an agent
Show visits per application for subscription {subscriptionUuid}.
Get visits by application in subscription {subscriptionUuid} at {resolution} resolution.
GET /subscriptions/{subscriptionUuid}/shield-acl List Shield ACL rules · Provides a list of Shield ACL rules #
Ask an LLM
“What Shield access control rules are set on my subscription?”
“Which IP addresses are allowed by Shield right now?”
Tell an agent
List the Shield ACL rules for subscription {subscriptionUuid}.
Show {limit} Shield ACL rules on subscription {subscriptionUuid}.
POST /subscriptions/{subscriptionUuid}/shield-acl Create a Shield ACL rule · Creates a Shield ACL rule #
Ask an LLM
“How do I allow a new set of IP addresses through Shield?”
“Can I add a described Shield access rule to my subscription?”
Tell an agent
Create a Shield ACL rule on subscription {subscriptionUuid} allowing {addresses}.
Add Shield rule "{description}" for addresses {addresses} to subscription {subscriptionUuid}.
GET /subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid} Get one Shield ACL rule · Returns the specified Shield ACL rule #
Ask an LLM
“Which addresses does a particular Shield rule cover?”
“Can I inspect a single Shield access control rule?”
Tell an agent
Show Shield ACL rule {shieldAclUuid} on subscription {subscriptionUuid}.
Get the details of Shield rule {shieldAclUuid} in subscription {subscriptionUuid}.
PUT /subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid} Update a Shield ACL rule · Updates a Shield ACL rule #
Ask an LLM
“Can I change the IP addresses on an existing Shield rule?”
“How do I edit the description of a Shield access rule?”
Tell an agent
Update Shield rule {shieldAclUuid} on subscription {subscriptionUuid} to allow {addresses}.
Change the description of Shield rule {shieldAclUuid} in subscription {subscriptionUuid} to {description}.
DELETE /subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid} Delete a Shield ACL rule · Deletes a Shield ACL rule #
Ask an LLM
“Can I remove a single Shield rule without resetting all of them?”
“How do I delete an outdated Shield access rule?”
Tell an agent destructive · confirm first
Delete Shield rule {shieldAclUuid} from subscription {subscriptionUuid}.
Remove Shield ACL entry {shieldAclUuid} on subscription {subscriptionUuid}.
POST /subscriptions/{subscriptionUuid}/shield-acl/actions/reset Reset Shield ACL rules to defaults · Resets Shield ACL rules to default settings #
Ask an LLM
“How do I wipe all custom Shield rules and go back to the defaults?”
“Is resetting Shield ACL rules reversible?”
Tell an agent destructive · confirm first
Reset all Shield ACL rules on subscription {subscriptionUuid} to defaults.
Clear every custom Shield rule from subscription {subscriptionUuid}.

Documentation

📖
Documentation
https://cloudapi-docs.acquia.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-subscriptions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/acquia:acquia-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

acquia-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Acquia Cloud API Documentation Subscriptions API
  x-logo:
    url: assets/cloud-platform.svg
    backgroundColor: '#FFFFFF'
    altText: Acquia Cloud
  description: 'Acquia Cloud API


    # Compatibility


    ## Stability


    The 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.'
  version: 2.0.0
  contact:
    name: Customer Experience Engineering (CXE)
    url: https://www.acquia.com
tags:


# --- truncated at 32 KB (154 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-subscriptions-api-openapi.yml