Acquia

Acquia is a leading provider of digital experience management solutions for organizations looking to enhance their online presence. They offer a range of services, including cloud hosting, digital asset management, and content management, to help businesses create, manage, and optimize their websites and digital experiences.

3 APIs 6 Features

ContentExperience

APIs

Acquia Cloud API

The Acquia Cloud API is a powerful tool that allows developers to programmatically interact with Acquia's cloud hosting platform. This API enables users to automate tasks, manag...

Acquia Cloud Site Factory API

Acquia Cloud Site Factory API is a powerful tool that allows developers to manage, customize, and automate various aspects of their websites and digital experiences. With this A...

Acquia Content Hub API

The Acquia Content Hub API is a powerful tool that allows users to easily distribute and share content across multiple websites and digital channels. By leveraging this API, con...

Collections

Acquia Cloud API - Account

OPEN

Acquia Cloud API - Agreements

OPEN

Acquia Cloud API - Application Performance Monitoring Services

OPEN

Acquia Cloud API - Applications

OPEN

Acquia Cloud API - Cloud IDE

OPEN

Acquia Cloud API - Codebases

OPEN

Acquia Cloud API - Current system health

OPEN

Acquia Cloud API - Distributions

OPEN

Acquia Cloud API - Email

OPEN

Acquia Cloud API - Environments

OPEN

Acquia Cloud API - Identity Providers

OPEN

Acquia Cloud API - Invite

OPEN

Acquia Cloud API - Messages

OPEN

Acquia Cloud API - Notifications

OPEN

Acquia Cloud API Documentation

OPEN

Acquia Cloud API - Options

OPEN

Acquia Cloud API - Organizations

OPEN

Acquia Cloud API - Private Networks

OPEN

Acquia Cloud API - Subscriptions

OPEN

Acquia Cloud API - Teams and Permissions

OPEN

Pricing Plans

Acquia Plans Pricing

8 plans

PLANS

Rate Limits

Acquia Rate Limits

2 limits

RATE LIMITS

FinOps

Acquia Finops

FINOPS

Features

Cloud Hosting

Managed Drupal hosting on Acquia Cloud with auto-scaling, CDN, and DDoS protection.

Application Management

Programmatic management of Drupal applications, environments, and deployments via Cloud API.

Multi-Site Factory

Acquia Cloud Site Factory for managing hundreds of Drupal sites from a centralized platform.

Content Syndication

Acquia Content Hub for distributing and synchronizing Drupal content across multiple sites.

Cloud IDE

Browser-based Cloud IDE for remote Drupal development with pre-configured environments.

OAuth2 Authentication

Secure API access via OAuth2 authorization code flow with scoped tokens.

Use Cases

Automated Deployment Pipelines

Integrate Acquia Cloud API into CI/CD pipelines for automated code deployment and cache clearing.

Multi-Environment Management

Manage dev, staging, and production Drupal environments programmatically.

Platform Administration

Automate team provisioning, SSH key management, and organizational access control.

Content Distribution

Use Content Hub API to distribute content across a network of Drupal sites.

Headless Drupal

Manage decoupled Drupal applications with Next.js or other frontend frameworks via Acquia APIs.

Semantic Vocabularies

Acquia Context

17 classes · 73 properties

JSON-LD

API Governance Rules

Acquia API Rules

32 rules · 14 errors 10 warnings 8 info

SPECTRAL

JSON Structure

Acquia Cloud Agreement Structure

10 properties

JSON STRUCTURE

Acquia Cloud Application Structure

11 properties

JSON STRUCTURE

Acquia Cloud Environment Structure

22 properties

JSON STRUCTURE

Acquia Cloud Error Structure

2 properties

JSON STRUCTURE

Acquia Cloud Ide Structure

5 properties

JSON STRUCTURE

Acquia Cloud Invite Structure

11 properties

JSON STRUCTURE

Acquia Cloud Notification Structure

14 properties

JSON STRUCTURE

Acquia Cloud Organization Structure

12 properties

JSON STRUCTURE

Acquia Cloud Ssh Key Structure

6 properties

JSON STRUCTURE

Acquia Cloud Subscription Structure

12 properties

JSON STRUCTURE

Acquia Cloud Team Structure

6 properties

JSON STRUCTURE

Acquia Cloud User Structure

20 properties

JSON STRUCTURE

Acquia Cloud Ux Message Structure

11 properties

JSON STRUCTURE

Example Payloads

Acquia Cloud Agreement Example

10 fields

EXAMPLE

Acquia Cloud Application Example

11 fields

EXAMPLE

Acquia Cloud Environment Example

22 fields

EXAMPLE

Acquia Cloud Error Example

2 fields

EXAMPLE

Acquia Cloud Ide Example

5 fields

EXAMPLE

Acquia Cloud Invite Example

11 fields

EXAMPLE

Acquia Cloud Notification Example

14 fields

EXAMPLE

Acquia Cloud Organization Example

12 fields

EXAMPLE

Acquia Cloud Ssh Key Example

6 fields

EXAMPLE

Acquia Cloud Subscription Example

12 fields

EXAMPLE

Acquia Cloud Team Example

6 fields

EXAMPLE

Acquia Cloud User Example

20 fields

EXAMPLE

Acquia Cloud Ux Message Example

11 fields

EXAMPLE

Resources

Certifications

GitHubOrganization

GitHubOrganization

SpectralRules

TermsOfService

Sources

opencollection: 1.0.0
info:
  name: Acquia Cloud API - Teams and Permissions
  version: 2.0.0
items:
- info:
    name: Teams and Permissions
    type: folder
  items:
  - info:
      name: Acquia Return a List of Permissions.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/permissions'
    docs: 'Displays a list of all available permissions currently in the system. This will include permissions that the user

      may not have access to.

      '
  - info:
      name: Acquia Return Details About a Specific Role.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/roles/:roleUuid'
      params:
      - name: roleUuid
        value: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'Roles may be assigned to team members, and grant various permissions to the applications that the team is assigned

      to. Roles are unique within a organization.

      '
  - info:
      name: Acquia Updates a Role.
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/roles/:roleUuid'
      params:
      - name: roleUuid
        value: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
        type: path
        description: The entity's universally unique identifier.
      body:
        type: form-urlencoded
        data:
        - name: description
          value: ''
        - name: name
          value: ''
        - name: permissions
          value: ''
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Modifies a role.
  - info:
      name: Acquia Deletes a Specific Role by its UUID.
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/roles/:roleUuid'
      params:
      - name: roleUuid
        value: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Deletes a specific role.
  - info:
      name: Acquia Return Teams the Current User Has Access To.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/teams'
      params:
      - name: sort
        value: field1,-field2
        type: query
        description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading
          - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

          '
      - name: filter
        value: ''
        type: query
        description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict
          the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not
          all fields are filterable.


          There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators
          are:


          * Equals: `= (%3D)`

          * Does not equal: `!= (!%3D)`

          * Greater than: `> (%3E)`

          * Less than: `< (%3C)`

          * Greater than or equal to: `>= (%3E%3D)`

          * Less than or equal to: `<= (%3C%3D)`

          * Contains substring: `=@ (%3D@)`

          * Does not contain substring: `!@ (!@)`


          Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and
          the `AND` operator is defined using a semi-colon (`;`).


          Some examples:

          * `filter=field%3Dvalue` (`field` equals `''value''`)

          * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals
          `''value''` AND `field2` > `5`)

          '
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items to return.
      - name: offset
        value: '10'
        type: query
        description: An integer to signify the offset to paginate from.
      - name: range
        value: ''
        type: query
        description: ISO-8601 date/time of invite create date/time.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'Returns a list of teams the current user has access to.


      Filterable fields:

      * `name`


      Sortable fields:

      * `name`

      '
  - info:
      name: Acquia Return Details About a Specific Team.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/teams/:teamUuid'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Return details about a specific team.
  - info:
      name: Acquia Change the Name of a Team.
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/teams/:teamUuid'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      body:
        type: form-urlencoded
        data:
        - name: name
          value: ''
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Change the name of a team.
  - info:
      name: Acquia Deletes a Specific Team by its UUID.
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/teams/:teamUuid'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Deletes a specific team by its UUID.
  - info:
      name: Acquia Removes the Current User from a Team.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/teams/:teamUuid/actions/leave'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Removes the current user from a team.
  - info:
      name: Acquia Returns a List of Applications This Team Has Access To.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/teams/:teamUuid/applications'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      - name: sort
        value: field1,-field2
        type: query
        description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading
          - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

          '
      - name: filter
        value: ''
        type: query
        description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict
          the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not
          all fields are filterable.


          There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators
          are:


          * Equals: `= (%3D)`

          * Does not equal: `!= (!%3D)`

          * Greater than: `> (%3E)`

          * Less than: `< (%3C)`

          * Greater than or equal to: `>= (%3E%3D)`

          * Less than or equal to: `<= (%3C%3D)`

          * Contains substring: `=@ (%3D@)`

          * Does not contain substring: `!@ (!@)`


          Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and
          the `AND` operator is defined using a semi-colon (`;`).


          Some examples:

          * `filter=field%3Dvalue` (`field` equals `''value''`)

          * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals
          `''value''` AND `field2` > `5`)

          '
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items to return.
      - name: offset
        value: '10'
        type: query
        description: An integer to signify the offset to paginate from.
    docs: 'Returns a list of applications this team has access to.


      Filterable fields:

      * `name`


      Sortable fields:

      * `name`

      '
  - info:
      name: Acquia Adds an Application to This Team.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/teams/:teamUuid/applications'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      body:
        type: form-urlencoded
        data:
        - name: uuid
          value: ''
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Adds an application to this team.
  - info:
      name: Acquia Removes the Application from This Team.
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/teams/:teamUuid/applications/:applicationUuid'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      - name: applicationUuid
        value: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Removes the application from this team. Team members will immediately lose access to this application.
  - info:
      name: Acquia Returns a List of Invitations to This Team.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/teams/:teamUuid/invites'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      - name: sort
        value: field1,-field2
        type: query
        description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading
          - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

          '
      - name: filter
        value: ''
        type: query
        description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict
          the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not
          all fields are filterable.


          There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators
          are:


          * Equals: `= (%3D)`

          * Does not equal: `!= (!%3D)`

          * Greater than: `> (%3E)`

          * Less than: `< (%3C)`

          * Greater than or equal to: `>= (%3E%3D)`

          * Less than or equal to: `<= (%3C%3D)`

          * Contains substring: `=@ (%3D@)`

          * Does not contain substring: `!@ (!@)`


          Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and
          the `AND` operator is defined using a semi-colon (`;`).


          Some examples:

          * `filter=field%3Dvalue` (`field` equals `''value''`)

          * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals
          `''value''` AND `field2` > `5`)

          '
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items to return.
      - name: offset
        value: '10'
        type: query
        description: An integer to signify the offset to paginate from.
      - name: range
        value: ''
        type: query
        description: ISO-8601 date/time of invite create date/time.
    docs: 'Returns a list of invitations to this team.


      Filterable fields:

      * `mail`

      * `token`

      * `author`


      Sortable fields:

      * `mail`

      * `token`

      * `author`

      '
  - info:
      name: Acquia Invites a User to Join a Team.
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/teams/:teamUuid/invites'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      body:
        type: form-urlencoded
        data: []
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Invites a user to join a team.
  - info:
      name: Acquia Returns a List of Team Members.
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/teams/:teamUuid/members'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      - name: sort
        value: field1,-field2
        type: query
        description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading
          - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

          '
      - name: filter
        value: ''
        type: query
        description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict
          the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not
          all fields are filterable.


          There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators
          are:


          * Equals: `= (%3D)`

          * Does not equal: `!= (!%3D)`

          * Greater than: `> (%3E)`

          * Less than: `< (%3C)`

          * Greater than or equal to: `>= (%3E%3D)`

          * Less than or equal to: `<= (%3C%3D)`

          * Contains substring: `=@ (%3D@)`

          * Does not contain substring: `!@ (!@)`


          Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and
          the `AND` operator is defined using a semi-colon (`;`).


          Some examples:

          * `filter=field%3Dvalue` (`field` equals `''value''`)

          * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)

          * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals
          `''value''` AND `field2` > `5`)

          '
      - name: limit
        value: '10'
        type: query
        description: The maximum number of items to return.
      - name: offset
        value: '10'
        type: query
        description: An integer to signify the offset to paginate from.
    docs: 'Returns a list of team members.


      Filterable fields:

      * `permission`

      * `first_name`

      * `last_name`

      * `user`


      Sortable fields:

      * `permission`

      * `first_name`

      * `last_name`

      '
  - info:
      name: Acquia Grant Team Roles to a Member.
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/teams/:teamUuid/members/:userUuid'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      - name: userUuid
        value: f2daa9cc-e5a0-4036-a5c8-f96e336c62b5
        type: path
        description: The entity's universally unique identifier.
      body:
        type: form-urlencoded
        data:
        - name: roles
          value: ''
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Grant team roles to a member.
  - info:
      name: Acquia Remove a User from a Team.
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/teams/:teamUuid/members/:userUuid'
      params:
      - name: teamUuid
        value: 3eef5d81-62f4-429c-aa94-e17d05ab4740
        type: path
        description: The entity's universally unique identifier.
      - name: userUuid
        value: f2daa9cc-e5a0-4036-a5c8-f96e336c62b5
        type: path
        description: The entity's universally unique identifier.
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://accounts.acquia.com/api/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Remove a user from a team.
bundled: true