Skip to content
Ona API Reference
Ona Docs
API Reference
Automations

CancelWorkflowExecution

automations.cancel_execution(AutomationCancelExecutionParams**kwargs) -> object
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"
ParametersExpand Collapse
workflow_execution_id: Optional[str]
formatuuid
ReturnsExpand Collapse
object

CancelWorkflowExecution

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.automations.cancel_execution(
    workflow_execution_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(response)
{}
Returns Examples
{}