Delete Workflow API

When you no longer need a workflow template, you can delete it by calling the Delete Workflow API.

Note that deleting a workflow only deletes the stored template—it does not deprovision its resources.

When a workflow is deleted, its corresponding status (returned by the Workflow State API) is also deleted unless either the provisioning status is IN_PROGRESS or resources have been provisioned.

Endpoints

DELETE /_plugins/_flow_framework/workflow/<workflow_id>

Path parameters

The following table lists the available path parameters.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Example request

DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50

DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50?clear_status=true

Example response

If the workflow exists, a delete response contains the status of the deletion, where the result field is set to deleted on success or not_found if the workflow does not exist (it may have already been deleted):

{
  "_index": ".plugins-flow_framework-templates",
  "_id": "8xL8bowB8y25Tqfenm50",
  "_version": 2,
  "result": "deleted",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 2,
  "_primary_term": 1
}