Skip to content
Console
On this page

Delete a workflow

Deletes a workflow.

Deletes a workflow.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow
  • Scope workflows:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection workflows
  • Query etag, allow_missing, validate_only, force

Request

FieldTypeWhat it is
namestringThe name of the workflow to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the workflow does not exist.
validate_onlyboolValidate without deleting anything.
forceboolAlso cancel and delete the Workflow's Runs and Schedules; without it a Workflow with open Runs or Schedules fails with INVALID_STATE.

Response

The call answers with an empty object.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"