Skip to main content

Function: deleteProject()

deleteProject(client, props): Promise<void>

Deletes a project.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; } = deleteProjectParamsSchema

Path parameters (orgName, projectName)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

Returns​

Promise<void>

Promise that resolves when the project is deleted

Operation Id​

delete-project

Example​

await deleteProject(client, {
  params: { orgName: 'my-org', projectName: 'my-project' }
});