dotCMS

dotCMS Bundle API

Content bundle management and deployment

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

POST /api/bundlePublisher/publish Receive and publish an incoming bundle · Publish #
Ask an LLM
“How does a receiving dotCMS server accept a pushed bundle and publish it?”
“Can I force-push a bundle to the receiver even if nothing changed?”
Tell an agent
Publish the incoming bundle with FORCE_PUSH set to {FORCE_PUSH}.
Push the bundle through the bundle publisher using filter {filterkey}.
DELETE /api/bundle/all Delete every bundle · Delete all #
Ask an LLM
“Can I wipe the entire publishing queue history of bundles in one go?”
“What deletes all bundles regardless of whether they succeeded or failed?”
Tell an agent destructive · confirm first
Delete every bundle in the publishing history.
Clear all bundles, successful and failed alike.
DELETE /api/bundle/all/fail Delete all failed bundles · Delete all fail #
Ask an LLM
“How do I clean up only the bundles that failed to publish?”
“Can I remove failed bundles but keep the successful ones?”
Tell an agent destructive · confirm first
Delete all bundles that failed to publish.
Clear the failed bundles from the publishing history.
DELETE /api/bundle/all/success Delete all successfully published bundles · Delete all success #
Ask an LLM
“Can I purge bundles that already published successfully?”
“Which call removes only the successful bundles from history?”
Tell an agent destructive · confirm first
Delete all bundles that published successfully.
Clear the successful bundles and keep the failed ones for review.
DELETE /api/bundle/ids Delete specific bundles by ID · Delete bundles by identifiers #
Ask an LLM
“Can I delete a handful of bundles by listing their IDs?”
“How do I remove particular bundles from the publishing history?”
Tell an agent destructive · confirm first
Delete the bundles with IDs {identifiers}.
Remove bundles {identifiers} from the publish history.
DELETE /api/bundle/olderthan/{olderThan} Delete bundles older than a date · Delete bundles older than #
Ask an LLM
“Can I clean out old bundles created before a certain date?”
“What removes stale bundles by age?”
Tell an agent destructive · confirm first
Delete all bundles older than {olderThan}.
Purge bundles created before {olderThan}.
GET /api/bundle/deleteenvironmentpushhistory/{params} Clear push history for an environment · Delete environment push history #
Ask an LLM
“Can I reset the push history for one publishing environment so everything pushes again?”
“Which call clears what was already pushed to a given environment?”
Tell an agent destructive · confirm first
Delete the push history for environment {params}.
Clear the record of assets pushed to the environment in {params}.
GET /api/bundle/deletepushhistory/{params} Clear push history for an asset · Delete push history #
Ask an LLM
“How do I clear the push history of a single piece of content?”
“Can I forget that an asset was pushed so it is sent again next time?”
Tell an agent destructive · confirm first
Delete the push history for the asset in {params}.
Clear push records for asset {params}.
GET /api/bundle/_download/{bundleId} Download a bundle file · Download bundle #
Ask an LLM
“Can I download a generated bundle as a file to move it manually?”
“Where do I fetch the archive for a bundle I already generated?”
Tell an agent
Download bundle {bundleId}.
Save the file for bundle {bundleId} so I can upload it elsewhere.
GET /api/bundle/{bundleId}/manifest Download a bundle's manifest · Download manifest #
Ask an LLM
“What assets are listed in a bundle's manifest?”
“Can I get just the manifest of a bundle rather than the whole file?”
Tell an agent
Download the manifest of bundle {bundleId}.
Show me the manifest file for bundle {bundleId}.
POST /api/bundle/_generate Generate a bundle file · Generate bundle #
Ask an LLM
“How do I build a bundle so it can be downloaded?”
“Can I generate a bundle for an unpublish operation instead of a publish?”
Tell an agent
Generate bundle {bundleId} for operation {operation}.
Build bundle {bundleId} using push filter {filterKey}.
GET /api/bundle/{bundleId}/assets List the assets in a bundle · Get publish queue elements #
Ask an LLM
“Which content and assets are queued inside a bundle?”
“Can I limit how many assets of a bundle are returned?”
Tell an agent
List the assets in bundle {bundleId}.
Show the first {limit} assets queued in bundle {bundleId}.
GET /api/bundle/getunsendbundles/{params} List bundles not yet sent · Get unsend bundles #
Ask an LLM
“Which bundles are still waiting to be sent?”
“Can I review bundles that were created but never pushed?”
Tell an agent
List the unsent bundles using {params}.
Show the bundles still waiting to be pushed for {params}.
GET /api/bundle/updatebundle/{params} Rename or update an unsent bundle · Update bundle #
Ask an LLM
“Can I rename a bundle before sending it?”
“Which call changes the details of a bundle that hasn't been pushed yet?”
Tell an agent
Update the bundle described by {params}.
Change the name of the unsent bundle given in {params}.
POST /api/bundle Upload a bundle for async publishing · Upload bundle async #
Ask an LLM
“How do I upload a bundle file and let it publish in the background?”
“Can I import a downloaded bundle without waiting for it to finish?”
Tell an agent
Upload bundle file {entity} and publish it asynchronously.
Import the bundle in {bodyParts} and return right away while it processes.
POST /api/bundle/sync Upload a bundle and wait for publishing · Upload bundle sync #
Ask an LLM
“Can I upload a bundle and block until it has finished publishing?”
“Which upload endpoint returns the publish result in the same response?”
Tell an agent
Upload bundle file {entity} synchronously and wait for the result.
Import the bundle in {bodyParts} and report when publishing completes.

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-bundle-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-bundle-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-bundle-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Bundle API
  version: '3'
  description: Content bundle management and deployment
servers:
- url: /
  description: dotCMS Server
tags:
- name: Bundle
  description: Content bundle management and deployment
paths:
  /api/bundlePublisher/publish:
    post:
      tags:
      - Bundle
      operationId: publish
      parameters:
      - name: type
        in: query
        schema:
          type: string
      - name: callback
        in: query
        schema:
          type: string
      - name: FORCE_PUSH
        in: query
        schema:
          type: boolean
      - name: filterkey
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Publish
      x-summary-source: derived
  /api/bundle/all:
    delete:
      tags:
      - Bundle
      operationId: deleteAll
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete all
      x-summary-source: derived
  /api/bundle/all/fail:
    delete:
      tags:
      - Bundle
      operationId: deleteAllFail
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete all fail
      x-summary-source: derived
  /api/bundle/all/success:
    delete:
      tags:
      - Bundle
      operationId: deleteAllSuccess
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete all success
      x-summary-source: derived
  /api/bundle/ids:
    delete:
      tags:
      - Bundle
      operationId: deleteBundlesByIdentifiers
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/DeleteBundlesByIdentifierForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete bundles by identifiers
      x-summary-source: derived
  /api/bundle/olderthan/{olderThan}:
    delete:
      tags:
      - Bundle
      operationId: deleteBundlesOlderThan
      parameters:
      - name: olderThan
        in: path
        required: true
        schema:
          type: string
          format: date-time
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete bundles older than
      x-summary-source: derived
  /api/bundle/deleteenvironmentpushhistory/{params}:
    get:
      tags:
      - Bundle
      operationId: deleteEnvironmentPushHistory
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete environment push history
      x-summary-source: derived
  /api/bundle/deletepushhistory/{params}:
    get:
      tags:
      - Bundle
      operationId: deletePushHistory
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete push history
      x-summary-source: derived
  /api/bundle/_download/{bundleId}:
    get:
      tags:
      - Bundle
      operationId: downloadBundle
      parameters:
      - name: bundleId
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/octet-stream: {}
      summary: Download bundle
      x-summary-source: derived
  /api/bundle/{bundleId}/manifest:
    get:
      tags:
      - Bundle
      operationId: downloadManifest
      parameters:
      - name: bundleId
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/octet-stream: {}
      summary: Download manifest
      x-summary-source: derived
  /api/bundle/_generate:
    post:
      tags:
      - Bundle
      operationId: generateBundle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateBundleForm'
      responses:
        default:
          description: default response
          content:
            application/octet-stream: {}
      summary: Generate bundle
      x-summary-source: derived
  /api/bundle/{bundleId}/assets:
    get:
      tags:
      - Bundle
      operationId: getPublishQueueElements
      parameters:
      - name: bundleId
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get publish queue elements
      x-summary-source: derived
  /api/bundle/getunsendbundles/{params}:
    get:
      tags:
      - Bundle
      operationId: getUnsendBundles
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get unsend bundles
      x-summary-source: derived
  /api/bundle/updatebundle/{params}:
    get:
      tags:
      - Bundle
      operationId: updateBundle
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Update bundle
      x-summary-source: derived
  /api/bundle:
    post:
      tags:
      - Bundle
      operationId: uploadBundleAsync
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Upload bundle async
      x-summary-source: derived
  /api/bundle/sync:
    post:
      tags:
      - Bundle
      operationId: uploadBundleSync
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Upload bundle sync
      x-summary-source: derived
components:
  schemas:
    MultiPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        bodyParts:
          type: array
          items:
            $ref: '#/components/schemas/BodyPart'
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'
    FormDataBodyPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        formDataContentDisposition:
          $ref: '#/components/schemas/FormDataContentDisposition'
        simple:
          type: boolean
        name:
          type: string
        value:
          type: string
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'
    FormDataContentDisposition:
      type: object
      properties:
        type:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
        fileName:
          type: string
        creationDate:
          type: string
          format: date-time
        modificationDate:
          type: string
          format: date-time
        readDate:
          type: string
          format: date-time
        size:
          type: integer
          format: int64
        name:
          type: string
    MessageBodyWorkers:
      type: object
    ParameterizedHeader:
      type: object
      properties:
        value:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
    ContentDisposition:
      type: object
      properties:
        type:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
        fileName:
          type: string
        creationDate:
          type: string
          format: date-time
        modificationDate:
          type: string
          format: date-time
        readDate:
          type: string
          format: date-time
        size:
          type: integer
          format: int64
    FormDataMultiPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        bodyParts:
          type: array
          items:
            $ref: '#/components/schemas/BodyPart'
        fields:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/FormDataBodyPart'
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'
    GenerateBundleForm:
      type: object
      properties:
        bundleId:
          type: string
        operation:
          type: string
          enum:
          - PUBLISH
          - UNPUBLISH
        filterKey:
          type: string
    DeleteBundlesByIdentifierForm:
      type: object
      properties:
        identifiers:
          type: array
          items:
            type: string
    BodyPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'