DeleteProject

projects.delete() -> object

POST/gitpod.v1.ProjectService/DeleteProject

Deletes a project permanently.

Use this method to:

Remove unused projects
Clean up test projects
Delete obsolete configurations

Examples

Delete project:

Permanently removes a project.

projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"

ParametersExpand Collapse

project_id: Optional[str]

project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

object

DeleteProject

import os
from gitpod import Gitpod

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

{}

Returns Examples

{}