52937ae5ca
Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Co-authored-by: David Jarzebowski <davidjarzebowski@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Steve Guntrip <stevecat@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Torsten Walter <torstenwalter@github.com> Co-authored-by: Henry Mercer <henrymercer@github.com> Co-authored-by: Sarah Edwards <skedwards88@github.com>
31 lines
1.9 KiB
Markdown
31 lines
1.9 KiB
Markdown
---
|
|
title: Packages
|
|
intro: >-
|
|
Use the REST API to interact with {% data variables.product.prodname_registry
|
|
%}.
|
|
versions:
|
|
feature: packages-rest-api
|
|
topics:
|
|
- API
|
|
redirect_from:
|
|
- /rest/reference/packages
|
|
autogenerated: rest
|
|
---
|
|
|
|
## About {% data variables.product.prodname_registry %}
|
|
|
|
You can use the REST API to manage packages in your {% data variables.product.prodname_dotcom %} repositories and organizations. For more information, see "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)."
|
|
|
|
To use the REST API to manage {% data variables.product.prodname_registry %}, you must authenticate using a {% data variables.product.pat_v1 %}.
|
|
- To access package metadata, your token must include the `read:packages` scope.
|
|
- To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes.
|
|
- To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes.
|
|
|
|
If your package is in a registry that supports granular permissions, then your token does not need the `repo` scope to access or manage this package. If your package is in a registry that only supports repository-scoped permissions, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. For a list of registries that only support repository-scoped permissions, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
|
|
{% ifversion ghec %}
|
|
To access resources in an organization with SSO enabled, you must enable SSO for your {% data variables.product.pat_v1 %}. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."
|
|
{% endif %}
|
|
|
|
<!-- Content after this section is automatically generated -->
|