## DeleteWorkflow

**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.

  ```yaml
  workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  ```

### Body Parameters

- `force: optional 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: optional string`

### Example

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

#### Response

```json
{}
```