Pause workflow¶

Pauses a workflow and its currently pausable executions.

HTTP
POST $CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/{workflow_id}/pause

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.

Input examples

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

Parameter reference

Parameter	Type	Required	Description
`workflow_id`	string	Yes	Workflow ID to pause.

Successful response¶

Returns 200 with the paused workflow detail. Other workflow detail fields follow Get workflow details.

Response example

JSON
{"code": "OK", "msg": "OK", "data": {"workflow": {"id": "wf-001", "name": "daily-import", "status": "paused", "available_actions": ["resume", "update", "delete"], "execution_summary": {"total_executions": 8, "active_executions": 0}}}}

Field reference

The following fields are in data.workflow.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.workflow`	object	Paused workflow detail.
`id`	string	Workflow ID.
`name`	string	Workflow name.
`status`	string	Status after pausing.
`available_actions`	string[]	Actions allowed in the current state.
`execution_summary`	object	Execution summary.
`execution_summary.total_executions`	integer	Total executions.
`execution_summary.active_executions`	integer	Active executions.

Error response¶

Response example

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

Field reference

Field	Type	Description
`code`	string	Error code.
`msg`	string	Error message.
`data`	null	Empty on error.

Next steps¶

Keep data.workflow.id. Use Resume workflow to continue it, or Get workflow details to check its status.

Last updated on Sep 15, 2026