Delete Deployment

Deletes a deployment by id.

Method

DELETE /deployment/{id}

Parameters

Path Parameters

Name Description
id The id of the deployment to be deleted.

Query Parameters

Name Description
cascade true, if all process instances, historic process instances and jobs for this deployment should be deleted.
skipCustomListeners true, if only the built-in ExecutionListeners should be notified with the end event.
skipIoMappings true, if all input/output mappings should not be invoked.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
404 application/json Deployment with id 'aDeploymentId' does not exist. See the Introduction for the error response format.

Example

Request

Delete a deployment with id aDeploymentId and cascade deletion to process instances, history process instances and jobs:

DELETE /deployment/aDeploymentId?cascade=true

Response

Status 204. No content.

On this Page: