Acquia Subscriptions API
The Subscriptions API from Acquia — 22 operation(s) for subscriptions.
Acquia Subscriptions API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 31 operations across 22 paths, and defines 44 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
31 operations
22 paths
44 schemas
3 DELETE19 GET1 OPTIONS6 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Acquia Subscriptions 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 31
Across 22 paths, the API surfaces 31 operations — 3 DELETE, 19 GET, 1 OPTIONS, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Subscriptions 31
GET
/subscriptions
Return a list of subscription.
GET
/subscriptions/{subscriptionUuid}
Return details about a specific subscription.
PUT
/subscriptions/{subscriptionUuid}
Modifies a subscription.
GET
/subscriptions/{subscriptionUuid}/applications
Provides a list of applications that are a part of the subscription.
GET
/subscriptions/{subscriptionUuid}/code-studio
Retrieves Code Studio metadata for a subscription.
/subscriptions/{subscriptionUuid}/code-studio
Displays Code Studio options for a subscription.
POST
/subscriptions/{subscriptionUuid}/code-studio/actions/enable
Enables Code Studio for a subscription.
GET
/subscriptions/{subscriptionUuid}/code-studio/applications
Retrieves a list of Code Studio enabled applications for a subscription.
GET
/subscriptions/{subscriptionUuid}/code-studio/users
Retrieves a list of users assigned to Code Studio for a subscription.
POST
/subscriptions/{subscriptionUuid}/code-studio/users
Assigns a user to a Code Studio seat for a subscription.
GET
/subscriptions/{subscriptionUuid}/code-studio/users/{userUuid}
Retrieves details about a specific Code Studio user.
DELETE
/subscriptions/{subscriptionUuid}/code-studio/users/{userUuid}
Unassigns a user from a Code Studio seat.
GET
/subscriptions/{subscriptionUuid}/domains
Returns a list of Domains registered with this subscription.
POST
/subscriptions/{subscriptionUuid}/domains
Registers a Domain with this subscription.
GET
/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}
Returns a speicific Domain registered with this subscription.
DELETE
/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}
Unregisters a Domain registered with this subscription.
POST
/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify
Triggers re-verification and update to the domain verification status.
GET
/subscriptions/{subscriptionUuid}/entitlements
Provides a list of entitlements that are a part of the subscription.
GET
/subscriptions/{subscriptionUuid}/ides
Returns a list of Cloud IDEs associated with this subscription.
GET
/subscriptions/{subscriptionUuid}/metrics/usage
Retrieves traversal links for a subscription's usage data.
GET
/subscriptions/{subscriptionUuid}/metrics/usage/data
Retrieves aggregate usage data for a subscription.
GET
/subscriptions/{subscriptionUuid}/metrics/usage/data-by-application
Retrieves usage data for a subscription, broken down by application.
GET
/subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}
Retrieves aggregate usage metric data for a subscription.
GET
/subscriptions/{subscriptionUuid}/metrics/usage/views-by-application
Retrieves views data for a subscription, broken down by application.
GET
/subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application
Retrieves visits data for a subscription, broken down by application.
GET
/subscriptions/{subscriptionUuid}/shield-acl
Provides a list of Shield ACL rules.
POST
/subscriptions/{subscriptionUuid}/shield-acl
Creates a Shield ACL rule.
GET
/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}
Returns the specified Shield ACL rule.
PUT
/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}
Updates a Shield ACL rule.
DELETE
/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}
Deletes a Shield ACL rule.
POST
/subscriptions/{subscriptionUuid}/shield-acl/actions/reset
Resets Shield ACL rules to default settings.
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_subscription (12 properties), Acquia_Cloud_API_Documentation_application-no-embedded (10 properties), Acquia_Cloud_API_Documentation_shield-acl (8 properties), Acquia_Cloud_API_Documentation_user-profile (8 properties). Each schema is shown below with its type and property counts.
Acquia_Cloud_API_Documentation_subscription-flags
object
An array of various flags that indicate functionality associated with subscription.
3 properties
Acquia_Cloud_API_Documentation_subscription-usage-metrics
object
A collection of usage metrics for a subscription.
3 properties
3 required
Acquia_Cloud_API_Documentation_pagination
object
A collection of pagination properties.
3 properties
Acquia_Cloud_API_Documentation_user-profile
object
A user profile.
8 properties
8 required
Acquia_Cloud_API_Documentation_subscription-applications
object
A collection of applications associated with a subscription.
3 properties
3 required
Acquia_Cloud_API_Documentation_subscription-stub
object
The subscription this application belongs to.
2 properties
2 required
Acquia_Cloud_API_Documentation_usage
object
A collection of traversal links for an entity.
1 property
1 required
Acquia_Cloud_API_Documentation_application-no-embedded
object
10 properties
10 required
Acquia_Cloud_API_Documentation_domain-registration-dns-records
object
3 properties
Acquia_Cloud_API_Documentation_validation-error
object
A validation error.
2 properties
2 required
Acquia_Cloud_API_Documentation_code-studio-applications
object
A collection of applications with associated Code Studio projects for a subscription.
4 properties
4 required
Acquia_Cloud_API_Documentation_environment-metadata
object
Environment metadata.
1 property
Acquia_Cloud_API_Documentation_code-studio-options
object
Code Studio options.
2 properties
Acquia_Cloud_API_Documentation_entitlements
object
Entitlements collection.
2 properties
Acquia_Cloud_API_Documentation_domain-registration-dns-record
object
A DNS record.
4 properties
2 required
Acquia_Cloud_API_Documentation_code-studio-users
object
A collection of users for a subscription with assigned seats for Code Studio.
4 properties
Acquia_Cloud_API_Documentation_subscription
object
A subscription is the product that allows for applications to be hosted with Acquia. In addition, a subscription grants access to various additional services.
12 properties
12 required
Acquia_Cloud_API_Documentation_ides
object
3 properties
3 required
Acquia_Cloud_API_Documentation_shield-acl
object
Shield ACL rule.
8 properties
8 required
Acquia_Cloud_API_Documentation_health
object
The current health for this resource.
3 properties
Acquia_Cloud_API_Documentation_domain-registrations
object
4 properties
Acquia_Cloud_API_Documentation_message-with-links
object
2 properties
2 required
Acquia_Cloud_API_Documentation_entitlement-consumption-based-pricing
object
Consumption based pricing entitlement.
5 properties
5 required
Acquia_Cloud_API_Documentation_organization-stub
object
2 properties
2 required
Acquia_Cloud_API_Documentation_ide
object
5 properties
4 required
Acquia_Cloud_API_Documentation_entitlement-cde
object
Continuous delivery environment entitlement.
5 properties
5 required
Acquia_Cloud_API_Documentation_entitlement-pipelines
object
Pipelines entitlement.
4 properties
4 required
Acquia_Cloud_API_Documentation_entitlement-shield
object
Shield entitlement.
4 properties
4 required
Acquia_Cloud_API_Documentation_code-studio-subscription-metadata
object
The Code Studio status for a subscription.
1 property
1 required
Acquia_Cloud_API_Documentation_message
object
1 property
1 required
Acquia_Cloud_API_Documentation_application-flags
object
An array of various flags that indicate functionality associated with applications.
1 property
Acquia_Cloud_API_Documentation_entitlement-default-newrelic
object
Represents the default New Relic account. The default New Relic account is created when a subscription is provisioned.
5 properties
5 required
Acquia_Cloud_API_Documentation_subscription-metadata
object
Subscription metadata.
1 property
Acquia_Cloud_API_Documentation_code-studio-application
object
The model for a Code Studio application.
4 properties
4 required
Acquia_Cloud_API_Documentation_code-studio-user
object
The model for a Code Studio user.
6 properties
6 required
Acquia_Cloud_API_Documentation_subscription-usage-metric
object
Provides details about views and visits for a subscription.
5 properties
4 required
Acquia_Cloud_API_Documentation_shield-acl-collection
object
Collection of Shield ACL rules.
3 properties
3 required
Acquia_Cloud_API_Documentation_error
object
2 properties
2 required
Acquia_Cloud_API_Documentation_code-studio-project-no-embedded
object
The model for a Code Studio project.
3 properties
3 required
Acquia_Cloud_API_Documentation_entitlement-log-forwarding
object
Log forwarding entitlement.
4 properties
4 required
Acquia_Cloud_API_Documentation_application-metadata
object
Application metadata.
1 property
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property
1 required
Acquia_Cloud_API_Documentation_domain-registration
object
The Domain Registration.
5 properties
5 required
Acquia_Cloud_API_Documentation_subscriptions
object
Collection of subscriptions.
3 properties
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 Applications API
Acquia Cloud IDE API
Acquia Codebases API
Acquia Current system health API
Acquia Distributions API
Acquia Email API
Acquia Environments API
#Subscriptions