v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
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"
    
post/gitpod.v1.WorkflowService/DeleteWorkflow

Request body

forceboolean

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.
workflowIdstring uuid

Response

Success

GitpodV1DeleteWorkflowResponse required