Delete resourceAdded in 8.6
POST/resources/:resourceKey/deletion
Strongly Consistent About endpoint data consistency
Deletes a deployed resource. This can be a process definition, decision requirements
definition, or form definition deployed using the deploy resources endpoint. Specify the
resource you want to delete in the resourceKey parameter.
Once a resource has been deleted it cannot be recovered. If the resource needs to be available again, a new deployment of the resource is required.
By default, only the resource itself is deleted from the runtime state. To also delete the
historic data associated with a resource, set the deleteHistory flag in the request body
to true. History deletion is supported for process definitions and decision requirements
definitions; for other resource types (forms, generic resources) the flag is ignored and no
history is deleted.
Deleting a process definition that is already draining is accepted again and changes
nothing: the definition stays DRAINING until its running instances finish. The one repeated
deletion that is rejected is one with deleteHistory set to true, because the history
cannot be deleted before the drain finishes.
The two supported types differ in how the history is removed. For a decision requirements
definition the history is deleted asynchronously via a batch operation whose details are
returned in the batchOperation field of the response. For a process definition that still
exists in the runtime state, the definition first drains its running instances and its
history is deleted asynchronously once the definition is fully removed cluster-wide; no batch
operation is returned in the response. If the process definition has already been removed
from the runtime state and the deletion is later re-triggered with deleteHistory set to
true, a batch operation is created immediately and returned in the batchOperation field.
Request
Responses
- 200
- 400
- 404
- 409
- 500
- 503
The resource is deleted. For a process definition that is already draining, the repeated deletion is accepted without effect and the definition stays DRAINING.
The provided data is not valid.
The resource is not found.
The process definition is still draining, so its history cannot be deleted yet. Retry with deleteHistory set to true once the definition is fully deleted; the batch operation is then created immediately.
An internal error occurred while processing the request.
The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains RESOURCE_EXHAUSTED. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure .