## DeleteWorkflow

`automations.delete(AutomationDeleteParams**kwargs)  -> object`

**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"
  ```

### Parameters

- `force: Optional[bool]`

  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.

- `workflow_id: Optional[str]`

### Returns

- `object`

### Example

```python
import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
automation = client.automations.delete(
    workflow_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
)
print(automation)
```

#### Response

```json
{}
```