Skip to content
Ona API Reference
Ona Docs
API Reference
Projects

DeleteProject

client.projects.delete(ProjectDeleteParams { projectId } body, RequestOptionsoptions?): ProjectDeleteResponse
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
body: ProjectDeleteParams { projectId }
projectId?: string

project_id specifies the project identifier

formatuuid
ReturnsExpand Collapse
ProjectDeleteResponse = unknown

DeleteProject

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const project = await client.projects.delete({ projectId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047' });

console.log(project);
{}
Returns Examples
{}