Delete workflow

Deletes a workflow and its versions, triggers, and execution records. This cannot be undone.

HTTP
DELETE $CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/{workflow_id}

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

Use Get workflow details to confirm the workflow.

Path parameters

Replace $CLOUDSIGMA_API_KEY, $WORKSPACE_ID, and $WORKFLOW_ID with your own values.

Shell
curl -X DELETE "$CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/$WORKFLOW_ID" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter

Type

Required

Description

workflow_id

string

Yes

Workflow ID to delete.

Successful response

Returns 200. deleted is true when the workflow has been deleted.

JSON
{"code": "OK", "msg": "OK", "data": {"deleted": true}}

Field

Type

Description

code

string

OK on success.

msg

string

OK on success.

data.deleted

boolean

Whether the workflow was deleted.

Error response

JSON
{"code": "ErrConflict", "msg": "Resource state conflict", "data": null}

Field

Type

Description

code

string

Error code.

msg

string

Error message.

data

null

Empty on error.

Next steps

Use List workflows with the same filters to confirm that the workflow is no longer returned.

Last updated on