Skip to content
Ona API Reference
Ona Docs
API Reference
Automations

DeleteWorkflow

client.automations.delete(AutomationDeleteParams { force, workflowId } body, RequestOptionsoptions?): AutomationDeleteResponse
POST/gitpod.v1.WorkflowService/DeleteWorkflow

Deletes a workflow permanently.

Use this method to:

  • Remove unused workflows
  • Clean up test workflows
  • Delete obsolete configurations

Examples

  • Delete workflow:

    Permanently removes a workflow.

    workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
ParametersExpand Collapse
body: AutomationDeleteParams { force, workflowId }
force?: boolean

force indicates whether to immediately delete the workflow and all related resources. When true, performs cascading deletion of:

  • All workflow executions
  • All workflow execution actions
  • All environments created by workflow actions
  • All agent executions created by workflow actions
  • The workflow itself When false (default), marks workflow executions for deletion and relies on background reconciliation to clean up resources.
workflowId?: string
formatuuid
ReturnsExpand Collapse
AutomationDeleteResponse = unknown

DeleteWorkflow

import Gitpod from '@gitpod/sdk';

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

const automation = await client.automations.delete({
  workflowId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

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