Module packages_api

Source

Enums§

PackagesSlashDeletePackageForAuthenticatedUserError
struct for typed errors of method packages_slash_delete_package_for_authenticated_user
PackagesSlashDeletePackageForOrgError
struct for typed errors of method packages_slash_delete_package_for_org
PackagesSlashDeletePackageForUserError
struct for typed errors of method packages_slash_delete_package_for_user
PackagesSlashDeletePackageVersionForAuthenticatedUserError
struct for typed errors of method packages_slash_delete_package_version_for_authenticated_user
PackagesSlashDeletePackageVersionForOrgError
struct for typed errors of method packages_slash_delete_package_version_for_org
PackagesSlashDeletePackageVersionForUserError
struct for typed errors of method packages_slash_delete_package_version_for_user
PackagesSlashGetAllPackageVersionsForPackageOwnedByAuthenticatedUserError
struct for typed errors of method packages_slash_get_all_package_versions_for_package_owned_by_authenticated_user
PackagesSlashGetAllPackageVersionsForPackageOwnedByOrgError
struct for typed errors of method packages_slash_get_all_package_versions_for_package_owned_by_org
PackagesSlashGetAllPackageVersionsForPackageOwnedByUserError
struct for typed errors of method packages_slash_get_all_package_versions_for_package_owned_by_user
PackagesSlashGetPackageForAuthenticatedUserError
struct for typed errors of method packages_slash_get_package_for_authenticated_user
PackagesSlashGetPackageForOrganizationError
struct for typed errors of method packages_slash_get_package_for_organization
PackagesSlashGetPackageForUserError
struct for typed errors of method packages_slash_get_package_for_user
PackagesSlashGetPackageVersionForAuthenticatedUserError
struct for typed errors of method packages_slash_get_package_version_for_authenticated_user
PackagesSlashGetPackageVersionForOrganizationError
struct for typed errors of method packages_slash_get_package_version_for_organization
PackagesSlashGetPackageVersionForUserError
struct for typed errors of method packages_slash_get_package_version_for_user
PackagesSlashListDockerMigrationConflictingPackagesForAuthenticatedUserError
struct for typed errors of method packages_slash_list_docker_migration_conflicting_packages_for_authenticated_user
PackagesSlashListDockerMigrationConflictingPackagesForOrganizationError
struct for typed errors of method packages_slash_list_docker_migration_conflicting_packages_for_organization
PackagesSlashListDockerMigrationConflictingPackagesForUserError
struct for typed errors of method packages_slash_list_docker_migration_conflicting_packages_for_user
PackagesSlashListPackagesForAuthenticatedUserError
struct for typed errors of method packages_slash_list_packages_for_authenticated_user
PackagesSlashListPackagesForOrganizationError
struct for typed errors of method packages_slash_list_packages_for_organization
PackagesSlashListPackagesForUserError
struct for typed errors of method packages_slash_list_packages_for_user
PackagesSlashRestorePackageForAuthenticatedUserError
struct for typed errors of method packages_slash_restore_package_for_authenticated_user
PackagesSlashRestorePackageForOrgError
struct for typed errors of method packages_slash_restore_package_for_org
PackagesSlashRestorePackageForUserError
struct for typed errors of method packages_slash_restore_package_for_user
PackagesSlashRestorePackageVersionForAuthenticatedUserError
struct for typed errors of method packages_slash_restore_package_version_for_authenticated_user
PackagesSlashRestorePackageVersionForOrgError
struct for typed errors of method packages_slash_restore_package_version_for_org
PackagesSlashRestorePackageVersionForUserError
struct for typed errors of method packages_slash_restore_package_version_for_user

Functions§

packages_slash_delete_package_for_authenticated_user
Deletes 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. OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, repo scope is also required. For the list these registries, see "About permissions for GitHub Packages."
packages_slash_delete_package_for_org
Deletes an entire package in an organization. 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. The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_delete_package_for_user
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. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_delete_package_version_for_authenticated_user
Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_delete_package_version_for_org
Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_delete_package_version_for_user
Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_all_package_versions_for_package_owned_by_authenticated_user
Lists package versions for a package owned by the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_all_package_versions_for_package_owned_by_org
Lists package versions for a package owned by an organization. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint if the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_all_package_versions_for_package_owned_by_user
Lists package versions for a public package owned by a specified user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_package_for_authenticated_user
Gets a specific package for a package owned by the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_package_for_organization
Gets a specific package in an organization. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_package_for_user
Gets a specific package metadata for a public package owned by a user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_package_version_for_authenticated_user
Gets a specific package version for a package owned by the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_package_version_for_organization
Gets a specific package version in an organization. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_get_package_version_for_user
Gets a specific package version for a public package owned by a specified user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_list_docker_migration_conflicting_packages_for_authenticated_user
Lists all packages that are owned by the authenticated user within the user’s namespace, and that encountered a conflict during a Docker migration. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.
packages_slash_list_docker_migration_conflicting_packages_for_organization
Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.
packages_slash_list_docker_migration_conflicting_packages_for_user
Lists all packages that are in a specific user’s namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.
packages_slash_list_packages_for_authenticated_user
Lists packages owned by the authenticated user within the user’s namespace. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_list_packages_for_organization
Lists packages in an organization readable by the user. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_list_packages_for_user
Lists all packages in a user’s namespace for which the requesting user has access. OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_restore_package_for_authenticated_user
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. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_restore_package_for_org
Restores an entire package in an organization. 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. The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_restore_package_for_user
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. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_restore_package_version_for_authenticated_user
Restores a package version owned by the authenticated user. You can restore a deleted package version 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. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_restore_package_version_for_org
Restores a specific package version in an organization. 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. The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."
packages_slash_restore_package_version_for_user
Restores a specific package version 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. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "About permissions for GitHub Packages." OAuth app tokens and personal access tokens (classic) need the read:packages and write:packages scopes to use this endpoint. If the package_type belongs to a GitHub Packages registry that only supports repository-scoped permissions, the repo scope is also required. For the list of these registries, see "About permissions for GitHub Packages."