Skip to main content

auth_user_packages

Overview

Nameauth_user_packages
TypeResource
Idgithub.packages.auth_user_packages

Fields

NameDatatypeDescription
idintegerUnique identifier of the package.
namestringThe name of the package.
created_atstring
html_urlstring
ownerobjectA GitHub user.
package_typestring
repositoryobjectMinimal Repository
updated_atstring
urlstring
version_countintegerThe number of versions of the package.
visibilitystring

Methods

NameAccessible byRequired ParamsDescription
get_package_for_authenticated_userSELECTpackage_name, package_typeGets a specific package for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the read:packages scope. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the repo scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "About permissions for GitHub Packages."
list_packages_for_authenticated_userSELECTpackage_typeLists packages owned by the authenticated user within the user's namespace.

To use this endpoint, you must authenticate using an access token with the read:packages scope. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the repo scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "About permissions for GitHub Packages."
delete_package_for_authenticated_userDELETEpackage_name, package_typeDeletes a package owned by the authenticated user. 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.

To use this endpoint, you must authenticate using an access token with the read:packages and delete:packages scopes.
If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the repo scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "About permissions for GitHub Packages."
restore_package_for_authenticated_userEXECpackage_name, package_typeRestores 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.

To use this endpoint, you must authenticate using an access token with the read:packages and write:packages scopes. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the repo scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "About permissions for GitHub Packages."