1.5 KiB
1.5 KiB
layout | title | parent | nav_order |
---|---|---|---|
default | Delete a workflow | Workflow APIs | 80 |
Delete a workflow
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.
{: .warning}
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 but does not deprovision its resources.
Path and HTTP methods
DELETE /_plugins/_flow_framework/workflow/<workflow_id>
Path parameters
The following table lists the available path parameters.
Parameter | Data type | Description |
---|---|---|
workflow_id |
String | The ID of the workflow to be retrieved. Required. |
Example request
DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50
{% include copy-curl.html %}
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
}