For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Manage the asset lifecycle

Unpublish and delete catalog assets to drive safe migrations for delivery teams.

Prerequisites​

Before you start, make sure you have set up the catalog and can submit assets through your CI/CD pipeline.

How delivery teams see asset versions​

As a center of excellence, you control which element templates delivery teams can discover and apply through the catalog. Over time you will update assets, replace them with successors, or remove them entirely. When you do, this affects how delivery teams see and use the assets.

Browsing assets​

When browsing the catalog, your delivery teams only see the latest published version of an asset. Older versions are not offered for new diagrams, and unpublished and deleted assets are not discoverable at all.

Used assets​

Diagrams that already reference a template continue to work with unpublished assets, but when an asset is unpublished, its template is also deprecated, so those diagrams show a deprecation hint that prompts teams to migrate.

Deleted assets used in diagrams are displayed as missing templates and can't be resolved.

Unpublish an asset​

When your CI/CD pipeline submits assets, the submission represents the full desired state of the catalog. Any asset that already exists in Camunda Hub but is not included in the submission is automatically unpublished. Therefore, to unpublish an asset, remove its directory from the asset repository, and run the sync pipeline again.

Unpublishing an asset also deprecates its element template. Deprecated templates continue to work in existing diagrams, but are no longer offered when applying templates or creating elements.

Diagrams that reference deprecated templates show a deprecation hint in the modeler. This gives delivery teams a clear signal to migrate.

For the center of excellence, responsible for managing the catalog, the asset remains visible, so you can:

  • Track which diagrams still reference the template.
  • Encourage the migration of those diagrams to a newer version or a different template before the asset is removed entirely.
note

Unpublishing is a catalog-level state that indicates the asset is no longer part of the current submission. Use it when an asset should no longer be offered to delivery teams—for example, when you replace a connector with a successor and want to drive migration off the old one.

Because unpublishing automatically deprecates the underlying element template, you don't need to manually set the deprecated property in the template to flag it as outdated; removing the asset from the submission is enough.

Delete an asset​

To permanently remove an asset from the catalog, use the Camunda Hub API delete endpoint:

DELETE <camunda-hub-api-base-url>/api/v2/catalog/assets/{assetKey}

For the full request and response schema, see the Delete a catalog asset reference for SaaS or Self-Managed. Your API token must have the delete permission.

Deleting an asset removes it and all of its versions entirely:

  • Center of excellence and delivery teams can no longer find it while browsing the catalog.
  • Its element template can no longer be resolved in diagrams.

Values already configured on diagram elements remain in the BPMN file, but the template definition—including labels, groupings, and validation—is no longer applied. The element is shown as a missing template.

warning

Deletion is irreversible. Use it to correct mistakes or remove assets that should never have been published. To phase out assets, prefer unpublishing so the template is deprecated and delivery teams have a clear migration path.

Next steps​