## DeleteProjects

`client.projects.bulkDelete(ProjectBulkDeleteParamsbody, RequestOptionsoptions?): ProjectBulkDeleteResponse`

**post** `/gitpod.v1.ProjectService/DeleteProjects`

Deletes multiple projects in a single request.

Use this method to:

- Remove multiple unused projects at once
- Clean up projects in batch

Returns successfully deleted project IDs and details about any failures.
Each project in the request is processed independently — partial success
is possible.

### Examples

- Delete multiple projects:

  Permanently removes several projects in one request.

  ```yaml
  projectIds:
    - "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    - "c1f23g7d-5d78-430e-b5b7-e0949c6eb158"
  ```

### Parameters

- `body: ProjectBulkDeleteParams`

  - `projectIds?: Array<string>`

### Returns

- `ProjectBulkDeleteResponse`

  - `deletedProjectIds?: Array<string>`

    deleted_project_ids contains the IDs of successfully deleted projects

  - `failedProjects?: Array<FailedProject>`

    failed_projects contains details about projects that failed to delete

    - `error?: string`

      error describes why the project deletion failed

    - `index?: number`

      index is the position in the request array (0-based)

    - `projectId?: string`

      project_id is the project ID that failed

### Example

```typescript
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.projects.bulkDelete({
  projectIds: ['b0e12f6c-4c67-429d-a4a6-d9838b5da047', 'c1f23g7d-5d78-430e-b5b7-e0949c6eb158'],
});

console.log(response.deletedProjectIds);
```

#### Response

```json
{
  "deletedProjectIds": [
    "string"
  ],
  "failedProjects": [
    {
      "error": "error",
      "index": 0,
      "projectId": "projectId"
    }
  ]
}
```