Skip to content

Function: deleteProject()

ts
function deleteProject(client, parameters): Promise<void>;

Defined in: src/cloud/api/projects.ts:178

Deletes a project.

You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.

Permissions required:Administer Jira global permission.

Parameters

ParameterTypeDescription
clientClient-
parameters{ enableUndo?: boolean; projectIdOrKey: string; }-
parameters.enableUndo?booleanWhether this project is placed in the Jira recycle bin where it will be available for restoration.
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).

Returns

Promise<void>