Skip to content
Ona API Reference
Ona Docs
API Reference
Automations

CancelWorkflowExecutionAction

client.automations.cancelExecutionAction(AutomationCancelExecutionActionParams { workflowExecutionActionId } body, RequestOptionsoptions?): AutomationCancelExecutionActionResponse
POST/gitpod.v1.WorkflowService/CancelWorkflowExecutionAction

Cancels a running workflow execution action.

Use this method to:

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

Examples

  • Cancel execution action:

    Stops a running workflow execution action.

    workflowExecutionActionId: "a1b2c3d4-5e6f-7890-abcd-ef1234567890"
ParametersExpand Collapse
body: AutomationCancelExecutionActionParams { workflowExecutionActionId }
workflowExecutionActionId?: string
formatuuid
ReturnsExpand Collapse
AutomationCancelExecutionActionResponse = unknown

CancelWorkflowExecutionAction

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.automations.cancelExecutionAction({
  workflowExecutionActionId: 'a1b2c3d4-5e6f-7890-abcd-ef1234567890',
});

console.log(response);
{}
Returns Examples
{}