user_packages
Overview
| Name | user_packages |
| Type | Resource |
| Id | github.packages.user_packages |
Fields
| Name | Datatype | Description |
|---|---|---|
id | integer | Unique identifier of the package. |
name | string | The name of the package. |
created_at | string | |
html_url | string | |
owner | object | A GitHub user. |
package_type | string | |
repository | object | Minimal Repository |
updated_at | string | |
url | string | |
version_count | integer | The number of versions of the package. |
visibility | string |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_package_for_user | SELECT | package_name, package_type, username | Gets a specific package metadata for a public package owned by a 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_user | SELECT | package_type, username | Lists all packages in a user's namespace for which the requesting user has access. 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_user | DELETE | package_name, package_type, username | Deletes an entire package for a 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. In addition:- 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 these registries, see "About permissions for GitHub Packages."- If the package_type belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "About permissions for GitHub Packages." |
restore_package_for_user | EXEC | package_name, package_type, username | Restores an entire package for a 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. In addition:- 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 these registries, see "About permissions for GitHub Packages."- If the package_type belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "About permissions for GitHub Packages." |