dotCMS

dotCMS Publishing API

Push publishing job management endpoints

GitHub OpenAPI

Operations 16

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 /api/auditPublishing/get/{bundleId} Get the publishing audit for a bundle · Get 2 #
Ask an LLM
“What does the publishing audit log say about a specific bundle?”
“Can I look up the audit status record of one bundle?”
Tell an agent
Get the publishing audit record for bundle {bundleId}.
Show the audit entry for bundle {bundleId}.
POST /api/auditPublishing/getAll List all publishing audit records · Get all #
Ask an LLM
“Can I pull every publishing audit record at once?”
“Where is the full push publishing audit log?”
Tell an agent
Get all publishing audit records.
Dump the whole push publishing audit log.
DELETE /api/v1/publishqueue Remove assets from the publish queue · Delete assets by identifiers #
Ask an LLM
“How do I take queued assets out of the publish queue?”
“Can I drop specific identifiers from the publishing queue?”
Tell an agent destructive · confirm first
Remove assets {identifiers} from the publish queue.
Dequeue identifiers {identifiers} from publishing.
POST /api/v1/bundles/assets Add assets to a bundle · Add assets to a bundle #
Ask an LLM
“How do I add content to a push publishing bundle?”
“Will a new bundle be created if the one I name doesn't exist?”
Tell an agent
Add assets {assetIds} to bundle {bundleId}.
Put {assetIds} into the bundle named {bundleName}, creating it if needed.
DELETE /api/v1/bundles/{bundleId}/assets Remove assets from an unpushed bundle · Remove assets from an unpushed bundle #
Ask an LLM
“Can I take items back out of a bundle before it's pushed?”
“What happens if I remove an asset that isn't in the bundle?”
Tell an agent destructive · confirm first
Remove assets {assetIds} from bundle {bundleId}.
Take {assetIds} out of unpushed bundle {bundleId}.
GET /api/v1/publishing/{bundleId} Get a publishing job's details · Get publishing job details #
Ask an LLM
“Why did my publishing job fail on one endpoint?”
“Can I see per-endpoint status and errors for a bundle push?”
Tell an agent
Get details of publishing job {bundleId}.
Show endpoint status and errors for bundle {bundleId}.
DELETE /api/v1/publishing/{bundleId} Delete a publishing job · Delete a publishing job #
Ask an LLM
“How do I remove one bundle from the publishing queue?”
“Can I delete a bundle that's currently sending?”
Tell an agent destructive · confirm first
Delete publishing job {bundleId}.
Remove bundle {bundleId} from the publishing queue.
GET /api/v1/publishing List publishing jobs · List publishing jobs #
Ask an LLM
“Which push publishing jobs are queued or done?”
“Can I filter publishing jobs by status or bundle name?”
Tell an agent
List publishing jobs.
List publishing jobs with status {status}.
DELETE /api/v1/publishing/purge Bulk delete publishing jobs by status · Bulk delete publishing jobs by status #
Ask an LLM
“How do I clear out all failed publishing jobs at once?”
“What gets purged if I don't specify a status?”
Tell an agent destructive · confirm first
Purge all publishing jobs with status {status}.
Purge finished and queued publishing jobs using the safe defaults.
POST /api/v1/publishing/push/{bundleId} Push a bundle to environments · Push bundle to environments #
Ask an LLM
“How do I push a bundle to my production environment?”
“Can I schedule a bundle to publish now and expire later?”
Tell an agent
Push bundle {bundleId} to {environments} with operation {operation} using filter {filterKey}.
Publish bundle {bundleId} to {environments} at {publishDate} with filter {filterKey} via {operation}.
POST /api/v1/publishing/retry Retry pushing bundles · Retry failed or successful bundles #
Ask an LLM
“Can I retry bundles that failed to publish?”
“How do I re-send a bundle that already succeeded to resync an endpoint?”
Tell an agent
Retry bundles {bundleIds}.
Force re-push bundles {bundleIds}.
GET /api/v1/pushpublish/filters/{filterKey} Get a push publishing filter · Get filter #
Ask an LLM
“What does a specific push publishing filter include?”
“Can I look up one publishing filter by its key?”
Tell an agent
Get push publishing filter {filterKey}.
Show the rules of filter {filterKey}.
DELETE /api/v1/pushpublish/filters/{filterKey} Delete a push publishing filter · Delete filter #
Ask an LLM
“How do I remove a push publishing filter?”
“Can I delete a filter I no longer use for bundles?”
Tell an agent destructive · confirm first
Delete push publishing filter {filterKey}.
Remove filter {filterKey}.
GET /api/v1/pushpublish/filters List push publishing filters · Get filters #
Ask an LLM
“Which push publishing filters are available?”
“What filters can I choose from when pushing a bundle?”
Tell an agent
List all push publishing filters.
Show the available publishing filters.
PUT /api/v1/pushpublish/filters Update a push publishing filter · Update from form #
Ask an LLM
“How do I edit an existing push publishing filter?”
“Can I change which roles can use a publishing filter?”
Tell an agent
Update push publishing filter {key} with title {title}.
Change the roles on existing filter {key} to {roles}.
POST /api/v1/pushpublish/filters Create a push publishing filter · Save from form #
Ask an LLM
“How do I create a new push publishing filter?”
“Can I make a new filter the default for bundles?”
Tell an agent
Create push publishing filter {key} titled {title}.
Add a new publishing filter {key} with rules {filters}.

Documentation

📖
Documentation
https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis
📖
APIReference
https://dev.dotcms.com/docs/build/apis/rest-apis/api-playground

Specifications

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

Other Resources

🔗
DeveloperPortal
https://dev.dotcms.com/
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/errors/dotcms-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/data-model/dotcms-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/conventions/dotcms-conventions.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/dotcms:dotcms-publishing-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

dotcms-publishing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Publishing API
  version: '3'
  description: Push publishing job management endpoints
servers:
- url: /
  description: dotCMS Server
tags:


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