Delete custom operator¶

Delete a custom operator. Deletion is irreversible; please confirm that no workflow needs to use this operator before calling it.

HTTP
DELETE $CLOUDSIGMA_API_BASE/workflow/v2/custom-operators/$OPERATOR_ID

Before you call this API¶

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

First query custom operator details to confirm the operator to be deleted.

Request¶

Input examples

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

Parameter reference

Request parameters

Successful response¶

Response confirms that the operator has been deleted. After deletion, the operator can no longer be queried, modified or used.

The response fields are as follows.

Response example

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

Field reference

Field	Type	Description
`code`	string	OK on success.
`msg`	string	OK on success.
`data.deleted`	boolean	true when deleted successfully.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "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¶

Query custom operator list, confirm that the target no longer appears.

Last updated on Sep 15, 2026