Skip to content
Ona Docs

CancelWorkflowExecution

POST/gitpod.v1.WorkflowService/CancelWorkflowExecution

Cancels a running workflow execution.

Use this method to:

  • Stop long-running executions
  • Cancel failed executions
  • Manage resource usage

Examples

  • Cancel execution:

    Stops a running workflow execution.

    workflowExecutionId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
Body ParametersJSONExpand Collapse
workflowExecutionId: optional string
formatuuid

CancelWorkflowExecution

curl https://app.gitpod.io/api/gitpod.v1.WorkflowService/CancelWorkflowExecution \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'
{}
Returns Examples
{}