Skip to content

Restore a package for the authenticated user

POST
/user/packages/{package_type}/{package_name}/restore

Restores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:

  • The package was deleted within the last 30 days.
  • The same package namespace and version is still available and not reused for a new package. 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.

OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. For more information, see “About permissions for GitHub Packages.”

API method documentation

package_type
required
string
Allowed values: npm maven rubygems docker nuget container

The type of supported package. Packages in GitHub’s Gradle registry have the type maven. Docker images pushed to GitHub’s Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub’s Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.

package_name
required
string

The name of the package.

token
string

Package token

Response

Requires authentication

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated
{
"message": "example",
"documentation_url": "example",
"url": "example",
"status": "example"
}

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated
{
"message": "example",
"documentation_url": "example",
"url": "example",
"status": "example"
}

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated
{
"message": "example",
"documentation_url": "example",
"url": "example",
"status": "example"
}