Articles in this section

Available Acquia APIs

When you configure an export, import, other type of flow step using the prebuilt Acquia connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Acquia API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Assets (v1)

Perform upload

X

Update metadata type

X

Post search

X

Get search

X

Delete asset

X

Asset details

X

Remove alternate preview

X

Upload alternate preview

X

Asset version list

X

Embed codes

X

Embed links

X

Get metadata

X

Update metadata

X

Preconversions list

X

Update security

X

Asset version details

X

Upload profiles list

X

Assets search

Post search

X

Get search

X

Categories (v1)

Create category

X

Adding/removing assets

X

Category tree

X

Edit category

X

Get category details

X

Post category details

X

Category list

X

Collections (v1)

Create collection

X

Adding/removing assets

X

Global collection list

X

Local collection list

X

Shared collection list

X

Get collection details

X

Post collection details

X

Embed codes

Embed codes

X

Embed links

X

File formats

File format list

X

Integration links

List integration links

X

Register integration link

X

Remove integration link

X

Metadata (v1)

Add metadata field value

X

Metadata types list

X

Orders

Conversions for order

X

Create order

X

Clean assets for order

X

Internet order profile list

X

Order details by sequence number

X

Order details by UUID

X

Get zip archive status/link

X

Create a zip archive

X

Users & contacts

User address

X

Analytics

List asset downloads

X

List asset shares

X

List asset views

X

Assets (v2)

Get asset groups

X

List by search query

X

Scrolling search results

X

Delete asset

X

Retrieve by ID

X

Delete alternate preview

X

Upload alternate preview

X

Rename asset

X

Retrieve asset metadata

X

Update asset metadata

X

Permanently delete asset

X

Retrieve asset security

X

Update asset security

X

List asset versions

X

Retrieve by ID and version

X

Upload asset

X

Chunked upload complete

X

Chunked upload start

X

Chunked upload status

X

Upload chunk

X

List all upload profiles

X

Attributes

List attributes

X

List vocabulary

X

Categories (v2)

List asset categories

X

List product categories

X

Channels

List channels

X

Get channel

X

Collections (v2)

List collections

X

Metadata (v2)

List metadata fields

X

List controlled vocabulary values

X

Add controlled vocabulary value

X

Delete controlled vocabulary value

X

Get controlled vocabulary value

X

Update controlled vocabulary value

X

Products

Create a new product

X

List products for channel

X

List products by search query

X

Delete product

X

Retrieve product by ID

X

Update attribute values

X

Update featured image

X

Update parent product

X

Update product category

X

Update product type

X

Rename product

X

Product types

List product types

X

Search connector

Instant search connector URL

X

Toggles

List toggles

X

Workflow app projects

Create new project

X

Delete project

X

Retrieve project by ID

X

Retrieve all project deliverables

X

Add deliverable to project

X

Delete deliverable

X

Retrieve deliverable by ID

X

Close deliverable

X

Upload proof to deliverable

X

Retrieve supporting files

X

Workflow webhooks

Delete webhook

X

List all webhooks

X

Add new webhook

X

Usage

Get API usage

X

Users

Get current user

X

Get user by ID

X

Acquia DAM webhooks

List webhooks

X

Create webhook

X

Delete webhook

X

Get webhook by ID

X

Edit webhook

X

Ping webhook by ID

X

Accessibility guidelines

List accessibility guidelines

X

Get accessibility guideline

X

Accessibility checks

List accessibility checks

X

Update an accessibility check

X

Accessibility

List accessibility source code excludes

X

Create accessibility source code exclude

X

Get accessibility source code exclude

X

Delete accessibility source code exclude

X

Update accessibility source code exclude

X

Get domains using this source code exclude

X

Set the domains assigned to the source code exclude

X

Account

Get account

X

Update account

X

Comments

List comments

X

Create comment

X

Get comment

X

Delete comment

X

Update comment

X

Crawl history digests

List crawl history digests

X

Pages

List pages

X

Exports

List exports

X

Create export

X

Get export

X

EULA

Get EULA status

X

Set EULA acceptance

X

Domains

List domains

X

Create domain

X

Endpoint name

X

Get domain

X

Delete domain

X

Update domain

X

Get favicon

X

Start on demand scan

X

Get accessibility checks

X

Update accessibility check

X

Get check help information

X

List pages for an accessibility check

X

Get pages with ignored accessibility checks

X

List pages

X

List PDF documents

X

Mark all domain PDFs as reviewed

X

Queue all domain PDFs for clarity ADA report

X

Request clarity remediation for all domain PDFs

X

Update a PDF (set reviewed)

X

Queue PDF for clarity ADA report

X

Request clarity remediation

X

Get accessibility groups

X

Get check for a subgroup

X

Get accessibility fast track

X

Get accessibility fast track source code

X

Submit closed caption request for video

X

Get checks for an accessibility source code

X

Ignore/unignore an accessibility check for a source code

X

Get pages for an accessibility check

X

Mark an accessibility check fixed for a source code on all pages

X

Get a summary for accessibility

X

Get clarity accessibility checks

X

Get clarity accessibility check

X

Get clarity accessibility check

X

Get clarity accessibility groups

X

Get a summary for clarity accessibility

X

List fixes for page fixes

X

Create a fix for page fixes

X

Delete page fixes

X

Delete a pagefix fix

X

Update a page fixes fix

X

List domain cookies

X

Create a domain cookie

X

Delete a cookie

X

Update a cookie

X

List consents

X

List consents

X

Get excluded IPs

X

List heatmaps rules for domain

X

Create a heatmap rule

X

Delete a heatmap rule

X

Update a heatmap rule

X

List heatmaps for domain

X

List page links

X

Get page link

X

List policies

X

List pages with policy matches

X

List pages with ignored policies

X

Get policy

X

List policy pages

X

List policy links

X

Get a list of data protection contents for domain

X

List enabled info types for domain with data protection

X

Get data protection fast-tracked contents

X

Get data protection content

X

Get data protection violations for a content

X

Get info types for a content

X

Ignore a data protection info type for a content

X

Summary of violations on the domain

X

Get a list of data protection violations for domain

X

Ignore a data protection violation for this domain

X

List crawls

X

Start crawl

X

Get the currently running scan

X

Cancel crawl in retry

X

List groups

X

Create group

X

Get updating status for groups

X

Update all groups

X

Get group

X

Delete group

X

Edit group

X

Get group history

X

Update group

X

Get a summary for the inventory module

X

List links

X

Get link

X

Patch link

X

List page links for a link

X

List pages with link

X

List original URLs for link

X

Get metadata for a link

X

List pages

X

Get page

X

Update a page

X

Get metadata for a page

X

Get clarity checks on a page

X

Get clarity accessibility errors on a PDF for a check

X

Update a clarity accessibility error for this PDF

X

Get accessibility summary

X

Get accessibility errors

X

Show an accessibility error for this page

X

Mark an accessibility error fixed for this page

X

Update an accessibility error for this page

X

Get accessibility checks on page

X

Ignore an accessibility check for page

X

Get accessibility errors on page for check

X

Mark accessibility errors fixed on page for check

X

Update accessibility errors on page for check

X

List page links

X

Get page link

X

Update page link

X

List other pages with link to page

X

List policies for a page

X

Delete policy match on page (mark fixed)

X

Update policy ignored state on page

X

List SEO issues for a page

X

Update (ignore/mark as fixed) a page SEO issue

X

Get content for SEO issue (like the images without alt or the page title)

X

Get a list of spelling errors for this page

X

Get spelling error

X

Mark spelling error fixed on this page

X

Ignore a spelling error for this page

X

Get a list of ignored misspellings for this page

X

Delete ignored misspelling

X

Get a statistics summary for a page

X

Get a list of visitors (by date) for a page

X

Get content for a page

X

Get the latest scan request for this page

X

Request a scan of the page

X

Get a list of data protection violations for this page

X

Show a data protection violation for this page

X

Ignore a data protection violation for this page

X

Get a list of info types with violations for this page

X

Get the CMS URL generated for the chosen CMS

X

Get the page inventory summary

X

Readability summary

X

Pages with readability level or reason

X

Calculate readability for a text

X

List uptimes

X

Create uptime

X

Get uptime

X

Delete uptime

X

Update uptime

X

Uptime report

X

List uptime logs

X

List uptime downtimes

X

List scheduled downtimes

X

Create scheduled downtime

X

Delete scheduled downtime

X

Create scheduled downtime

X

List pages

X

List SEO issues

X

Ignored/unignore an issue

X

Pages for a given issue

X

Content info for an issue (like duplicate title)

X

List pages

X

Summary

X

List spelling errors

X

Get a spelling error

X

Mark spelling error fixed

X

Patch a spelling error

X

Get pages for a spelling error

X

List words in dictionary

X

Add word to dictionary

X

Remove word from dictionary

X

List languages

X

List pages

X

Summary

X

Get event categories data

X

Get event actions data

X

Get event names data

X

Get pages with most visits

X

Get pages with least visits

X

Get entry pages

X

Get exit pages

X

Get pages without visits

X

Get documents without downloads

X

Request pages and documents by URL

X

Get search engines

X

Get referrers

X

Get keywords

X

Get social referrers

X

Get a list of all visitors

X

Get a list of organizations

X

Get a list of browsers

X

Get a list of operating systems

X

Get a list of languages

X

Get a list of devices

X

Get a list of resolutions

X

Get a list of locations (countries) with visits

X

Get a list of regions with visits

X

Get a list of cities with visits

X

Get summary

X

Get summary per date

X

Get downloads data

X

Request downloads by URL

X

Get site search keywords with results

X

Get site search keywords without results

X

List pages

X

Get a quality summary

X

Heatmaps rules

List heatmaps rules

X

Info types

List info types for data protection

X

Jobs

Get task

X

Labels

List labels

X

Create label

X

Get label

X

Delete label

X

Update label

X

Get domain groups using the label

X

Me

Own profile

X

Update profile

X

Update the auth user's settings for a domain

X

Get exports

X

Create report

X

Stop receiving report

X

Update report

X

Get reportings

X

Create reporting

X

Get reporting

X

Performance

Retrieve a list of performance scan profiles and their pages

X

Set performance scan profiles to a page

X

Unassign a profile from a page

X

Update settings for performance scan profiles on a page

X

Return a list of performance profiles available for the customer

X

Create a performance profile

X

Get a single profile

X

Update a performance profile for a given customer

X

Archive a performance profile for a given customer

X

Retrieve the scan status for a given page with a performance profile

X

Enqueue a rescan for a given page with a performance profile

X

Return a performance scan result for a given page with a profile

X

Retrieve the latest report for a given page and profile

X

Plans

List plans

X

Policies

List policies

X

Create policy

X

List users who created policies

X

Get policy

X

Delete policy

X

Update policy

X

Run policy matching

X

Create chat with policy bot

X

Add a message to the chat

X

Give feedback on a set of policies

X

Reports

List reports

X

Create report

X

Delete report

X

Update report

X

Scores

List scores

X

Support

Create feedback

X

Create a request

X

Users

List users

X

Create user

X

Get user

X

Delete user

X

Update user

X

Spelling tool

List the languages supported by the spelling tool

X

Audit logs

Get audit logs

X

Agreements

Own account agreements

X

Notifications

List notifications

X

API users

List API users

X

Create API user

X

Get API user

X

Delete API user

X

Revoke current token and generate a new one

X

Source code excludes

List source code excludes

X

Create source code exclude

X

Get source code exclude

X

Delete source code exclude

X

Update source code exclude

X

Get domains using this source code exclude

X

Set the domains assigned to the source code exclude

X

Scans

List scan requests

X

Request the scan of a page

X

Get scan request

X

HTML scans

List scan requests

X

Request the scan of an HTML page

X

Get scan request

X

Verticals

Get list of available verticals

X

Link excludes

List link excludes for a specific CMS

X

Path constraints

List path constraints for a specific CMS

X

Ping

Endpoint name

X