DeleteProjects

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"

Body ParametersJSONExpand Collapse

projectIds: optional array of string

ReturnsExpand Collapse

deletedProjectIds: optional array of string

deleted_project_ids contains the IDs of successfully deleted projects

failedProjects: optional array of object { error, index, projectId }

failed_projects contains details about projects that failed to delete

error: optional string

error describes why the project deletion failed

index: optional number

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

formatint32

projectId: optional string

project_id is the project ID that failed

DeleteProjects

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

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

Returns Examples

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