Delete workflow job¶

Delete a workflow job record. This operation is irreversible.

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

Before you call this API¶

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

First query job details to confirm that the job has reached the final state.

Request¶

Input examples

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

Parameter reference

Path parameters

Parameter	Type	Required	Description
`workflow_id`	string	Required	Workflow ID.
`execution_id`	string	Required	Job ID.

Successful response¶

When code in the response is OK and data.deleted is true, the server has deleted the job record. Deletion is irreversible.

Response example

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

Field reference

Field	Type	Description
`code`	string	`OK` when successful.
`msg`	string	`OK` when successful.
`data.deleted`	boolean	`true` indicates that the job record has been deleted.

Error response¶

Response example

JSON
{
  "code": "ErrNotFound",
  "msg": "资源不存在",
  "data": null
}

Field reference

Field	Type	Description
`code`	string	Error code.
`msg`	string	Readable error message.
`data`	null	`null` in an error response.

Follow-up operations¶

View workflow jobs, confirm that the job record no longer appears.

Last updated on Sep 15, 2026