2.3 KiB
title, intro, versions, topics, miniTocMaxHeadingLevel, redirect_from
| title | intro | versions | topics | miniTocMaxHeadingLevel | redirect_from | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Packages | With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations. |
|
|
3 |
|
About the {% data variables.product.prodname_registry %} API
The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "Restoring and deleting packages."{% endif %}
To use this API, you must authenticate using a personal access token.
- To access package metadata, your token must include the
read:packagesscope. - To delete packages and package versions, your token must include the
read:packagesanddelete:packagesscopes. - To restore packages and package versions, your token must include the
read:packagesandwrite:packagesscopes.
If your package_type is npm, maven, rubygems, or nuget, then your token must also include the repo scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. If your package is in the {% data variables.product.prodname_container_registry %}, then your package_type is container and your token does not need the repo scope to access or manage this package_type. container packages offer granular permissions separate from a repository. For more information, see "About permissions for {% data variables.product.prodname_registry %}."
If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "Authorizing a personal access token for use with SAML single sign-on{% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}