Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
16 KiB
title, intro, product, redirect_from, versions, shortTitle
| title | intro | product | redirect_from | versions | shortTitle | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Deleting and restoring a package | Learn how to delete or restore a package. | {% data reusables.gated-features.packages %} |
|
|
Delete & restore a package |
{% data reusables.package_registry.packages-ghes-release-stage %}
Package deletion and restoration support on {% data variables.product.prodname_dotcom %}
On {% data variables.product.prodname_dotcom %} if you have the required access, you can delete:
- an entire private package
- an entire public package, if there's not more than 5000 downloads of any version of the package
- a specific version of a private package
- a specific version of a public package, if the package version doesn't have more than 5,000 downloads
{% note %}
Note:
- You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
- When deleting public packages, be aware that you may break projects that depend on your package.
{% endnote %}
On {% data variables.product.prodname_dotcom %}, you can also restore an entire package or package version, if:
- You restore the package within 30 days of its deletion.
- The same package namespace is still available and not used for a new package.
{% ifversion fpt or ghec or ghes %}
Packages API support
{% ifversion fpt or ghec %}
You can use the REST API to manage your packages. For more information, see the "{% data variables.product.prodname_registry %} API."
{% endif %}
For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "Deleting a version of a repository-scoped package with GraphQL."
{% endif %}
Required permissions to delete or restore a package
For packages that inherit their access permissions from repositories, you can delete a package if you have admin permissions to the repository.
The {% data variables.product.prodname_registry %} registries below only use repository-scoped permissions:
{% ifversion not fpt or ghec %}- Docker images at docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME{% endif %}
{% ifversion packages-npm-v2 %}{% else %}- npm{% endif %}
- RubyGems registry
- Apache Maven registry
- NuGet registry
{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %}
{% ifversion fpt or ghec %}
To delete a package that has granular permissions separate from a repository, such as container images stored at https://ghcr.io/OWNER/PACKAGE-NAME or https://npm.pkg.github.com/OWNER/PACKAGE-NAME, you must have admin access to the package. For more information, see "About permissions for {% data variables.product.prodname_registry %}."
{% endif %}
Deleting a package version
Deleting a version of a repository-scoped package on {% data variables.product.prodname_dotcom %}
To delete a version of a repository-scoped package, you must have admin permissions to the repository that owns the package. For more information, see "Required permissions."
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.package_registry.packages-from-code-tab %}
{% data reusables.package_registry.package-settings-option %}
5. On the left, click Manage versions.
5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select Delete version.
6. To confirm deletion, type the package name and click I understand the consequences, delete this version.

{% ifversion fpt or ghec or ghes %}
Deleting a version of a repository-scoped package with GraphQL
For packages that inherit their permissions and access from repositories, you can use the GraphQL to delete a specific package version.
{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "{% data variables.product.prodname_registry %} API."{% endif %}
Use the deletePackageVersion mutation in the GraphQL API. You must use a token with the read:packages, delete:packages, and repo scopes. For more information about tokens, see "About {% data variables.product.prodname_registry %}."
The following example demonstrates how to delete a package version, using a packageVersionId of MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg.
curl -X POST \
-H "Accept: application/vnd.github.package-deletes-preview+json" \
-H "Authorization: bearer TOKEN" \
-d '{"query":"mutation { deletePackageVersion(input:{packageVersionId:\"MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg==\"}) { success }}"}' \
HOSTNAME/graphql
To find all of the private packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the packages connection through the repository object. You will need a token with the read:packages and repo scopes. For more information, see the packages connection or the PackageOwner interface.
For more information about the deletePackageVersion mutation, see "deletePackageVersion."
You cannot directly delete an entire package using GraphQL, but if you delete every version of a package, the package will no longer show on {% data variables.product.product_name %}.
{% endif %}
{% ifversion fpt or ghec %}
Deleting a version of a user-scoped package on {% data variables.product.prodname_dotcom %}
To delete a specific version of a user-scoped package on {% data variables.product.prodname_dotcom %}, such as for a Docker image at ghcr.io, use these steps. To delete an entire package, see "Deleting an entire user-scoped package on {% data variables.product.prodname_dotcom %}."
To review who can delete a package version, see "Required permissions."
{% data reusables.package_registry.package-settings-from-user-level %}
{% data reusables.package_registry.package-settings-option %}
5. On the left, click Manage versions.
5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select Delete version.
6. To confirm deletion, type the package name and click I understand the consequences, delete this version.

Deleting a version of an organization-scoped package on {% data variables.product.prodname_dotcom %}
To delete a specific version of an organization-scoped package on {% data variables.product.prodname_dotcom %}, such as for a Docker image at ghcr.io, use these steps.
To delete an entire package, see "Deleting an entire organization-scoped package on {% data variables.product.prodname_dotcom %}."
To review who can delete a package version, see "Required permissions to delete or restore a package."
{% data reusables.package_registry.package-settings-from-org-level %}
{% data reusables.package_registry.package-settings-option %}
5. On the left, click Manage versions.
5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select Delete version.
6. To confirm deletion, type the package name and click I understand the consequences, delete this version.
{% endif %}
Deleting an entire package
Deleting an entire repository-scoped package on {% data variables.product.prodname_dotcom %}
To delete an entire repository-scoped package, you must have admin permissions to the repository that owns the package. For more information, see "Required permissions."
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.package_registry.packages-from-code-tab %}
{% data reusables.package_registry.package-settings-option %}
4. Under "Danger Zone", click Delete this package.
5. To confirm, review the confirmation message, enter your package name, and click I understand, delete this package.

{% ifversion fpt or ghec %}
Deleting an entire user-scoped package on {% data variables.product.prodname_dotcom %}
To review who can delete a package, see "Required permissions."
{% data reusables.package_registry.package-settings-from-user-level %}
{% data reusables.package_registry.package-settings-option %}
5. On the left, click Options.
6. Under "Danger zone", click Delete this package.
6. To confirm deletion, type the package name and click I understand the consequences, delete this package.

Deleting an entire organization-scoped package on {% data variables.product.prodname_dotcom %}
To review who can delete a package, see "Required permissions."
{% data reusables.package_registry.package-settings-from-org-level %}
{% data reusables.package_registry.package-settings-option %}
5. On the left, click Options.
6. Under "Danger zone", click Delete this package.
6. To confirm deletion, type the package name and click I understand the consequences, delete this package.
{% endif %}
Restoring packages
You can restore a deleted package or version if:
- You restore the package within 30 days of its deletion.
- The same package namespace and version is still available and not reused for a new package.
For example, if you have a deleted RubyGems package named octo-package that was scoped to the repo octo-repo-owner/octo-repo, then you can only restore the package if the package namespace rubygem.pkg.github.com/octo-repo-owner/octo-repo/octo-package is still available, and 30 days have not yet passed.
{% ifversion fpt or ghec %} To restore a deleted package, you must also meet one of these permission requirements:
- For repository-scoped packages: You have admin permissions to the repository that owns the deleted package.{% ifversion fpt or ghec %}
- For user-account scoped packages: Your personal account owns the deleted package.
- For organization-scoped packages: You have admin permissions to the deleted package in the organization that owns the package.{% endif %} {% endif %}
{% ifversion ghae or ghes %} To delete a package, you must also have admin permissions to the repository that owns the deleted package. {% endif %}
For more information, see "Required permissions."
Once the package is restored, the package will use the same namespace it did before. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
Restoring a package in an organization
You can restore a deleted package through your organization account settings, as long as the package was in a repository owned by the organizaton{% ifversion fpt or ghec %} or had granular permissions and was scoped to your organization account{% endif %}.
To review who can restore a package in an organization, see "Required permissions."
{% data reusables.organizations.navigate-to-org %}
{% data reusables.organizations.org_settings %}
3. On the left, click Packages.
4. Under "Deleted Packages", next to the package you want to restore, click Restore.
5. To confirm, type the name of the package and click I understand the consequences, restore this package.

{% ifversion fpt or ghec %}
Restoring a user-account scoped package
You can restore a deleted package through your personal account settings, if the package was in one of your repositories or scoped to your personal account. For more information, see "Required permissions."
{% data reusables.user-settings.access_settings %}
2. On the left, click Packages.
4. Under "Deleted Packages", next to the package you want to restore, click Restore.
5. To confirm, type the name of the package and click I understand the consequences, restore this package.

{% endif %}
Restoring a package version
You can restore a package version from your package's landing page. To review who can restore a package, see "Required permissions."
- Navigate to your package's landing page.
- On the right, click Package settings.
- On the left, click Manage versions.
- On the top right, use the "Versions" drop-down menu and select Deleted.

- Next to the deleted package version you want to restore, click Restore.

- To confirm, click I understand the consequences, restore this version.
