Skip to main content

Delete Workflow

Endpoint: DELETE /api/workflow/{workflowId}/remove

Deletes a workflow execution from the server using the workflow (execution) ID.

Path parameters

ParameterDescriptionTypeRequired/ Optional
workflowIdThe execution ID of the workflow to be deleted.stringRequired.

Query parameters

ParameterDescriptionTypeRequired/ Optional
archiveWorkflowNote: This parameter is deprecated. There is no effect when configured.

If set to true, the workflow will be archived instead of permanently deleted.
booleanOptional.

Response

Returns 200 OK, indicating that the workflow has been deleted successfully.

Examples

Delete workflow execution

Request

curl -X 'DELETE' \
'https://<YOUR_CLUSTER>/api/workflow/373eabef-b846-11ef-b090-be4a9a728270/remove' \
-H 'accept: */*' \
-H 'X-Authorization: <TOKEN>'

Response

Returns 200 OK, indicating that the workflow has been deleted successfully.