DeleteProjects

client.Projects.BulkDelete(ctx, body) (*ProjectBulkDeleteResponse, error)

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.

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

ParametersExpand Collapse

body ProjectBulkDeleteParams

ProjectIDs param.Field[[]string]Optional

ReturnsExpand Collapse

type ProjectBulkDeleteResponse struct{…}

DeletedProjectIDs []stringOptional

deleted_project_ids contains the IDs of successfully deleted projects

FailedProjects []ProjectBulkDeleteResponseFailedProjectOptional

failed_projects contains details about projects that failed to delete

Error stringOptional

error describes why the project deletion failed

Index int64Optional

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

formatint32

ProjectID stringOptional

project_id is the project ID that failed

DeleteProjects

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Projects.BulkDelete(context.TODO(), gitpod.ProjectBulkDeleteParams{
    ProjectIDs: gitpod.F([]string{"b0e12f6c-4c67-429d-a4a6-d9838b5da047", "c1f23g7d-5d78-430e-b5b7-e0949c6eb158"}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.DeletedProjectIDs)
}

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

Returns Examples

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