> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete Projects

> Deletes multiple projects in a single request.

`Unary` · [`Projects`](/docs/api-reference/generated/project/overview)

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 theme={null}
  projectIds:
    - "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    - "c1f23g7d-5d78-430e-b5b7-e0949c6eb158"
  ```

## Endpoint

```text theme={null}
POST /api/gitpod.v1.ProjectService/DeleteProjects
```

Send a Bearer token as described in [Authentication](/docs/api-reference#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

<CodeGroup>
  ```bash cURL theme={null}
  export ONA_HOST=https://app.ona.com
  export ONA_API_KEY=<your-token>

  curl --request POST \
    --url "$ONA_HOST/api/gitpod.v1.ProjectService/DeleteProjects" \
    --header "Authorization: Bearer $ONA_API_KEY" \
    --header "Content-Type: application/json" \
    --data '{
    "projectIds": [
      "<project-ids>"
    ]
  }'
  ```

  ```python Python theme={null}
  import gitpod.v1.project_pb2 as project_pb2
  from ona_sdk import create_client_from_env

  ona = create_client_from_env()
  request = project_pb2.DeleteProjectsRequest(
      project_ids=["<project-ids>"],
  )
  response = ona.services.project.delete_projects(request)
  print(response)
  ```

  ```typescript TypeScript theme={null}
  import { create } from "@bufbuild/protobuf";
  import { createClientFromEnv } from "@gitpod/sdk";
  import { DeleteProjectsRequestSchema } from "@gitpod/sdk/gitpod/v1/project_pb";

  async function main() {
    const ona = createClientFromEnv();
    const request = create(DeleteProjectsRequestSchema, {
      projectIds: ["<project-ids>"],
    });
    const response = await ona.services.project.deleteProjects(request);
    console.log(response);
  }

  main().catch(console.error);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"log"

  	"connectrpc.com/connect"
  	"github.com/gitpod-io/gitpod-sdk-go/sdk"
  	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
  )

  func main() {
  	ona, err := sdk.NewFromEnv()
  	if err != nil {
  		log.Fatal(err)
  	}

  	request := connect.NewRequest(&gitpodpb.DeleteProjectsRequest{
  		ProjectIds: []string{"<project-ids>"},
  	})
  	response, err := ona.Services.Project.DeleteProjects(context.Background(), request)
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Println(response.Msg)
  }
  ```

  ```json Request body theme={null}
  {
    "projectIds": [
      "<project-ids>"
    ]
  }
  ```
</CodeGroup>

## Request

`gitpod.v1.DeleteProjectsRequest`

| Field        | Type            | Required | Description                                                                                   |
| ------------ | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| `projectIds` | array of string | No       | Constraints: `repeated.items.string.uuid=true, repeated.max_items=100, repeated.min_items=1`. |

## Response

`gitpod.v1.DeleteProjectsResponse`

| Field               | Type                                                                 | Required | Description                                                             |
| ------------------- | -------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------- |
| `deletedProjectIds` | array of string                                                      | No       | deleted\_project\_ids contains the IDs of successfully deleted projects |
| `failedProjects`    | array of [Failure](#type-gitpod-v1-delete-projects-response-failure) | No       | failed\_projects contains details about projects that failed to delete  |

## Related types

<a id="type-gitpod-v1-delete-projects-response-failure" />

<Accordion title="Failure">
  `gitpod.v1.DeleteProjectsResponse.Failure`

  | Field       | Type    | Required | Description                                          |
  | ----------- | ------- | -------- | ---------------------------------------------------- |
  | `index`     | integer | No       | index is the position in the request array (0-based) |
  | `projectId` | string  | No       | project\_id is the project ID that failed            |
  | `error`     | string  | No       | error describes why the project deletion failed      |
</Accordion>