Enterprise Cloud

Enterprise Server

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

在 GitHub 旅程中随时为你提供帮助。

可以是以下选项之一

名称

所有 {{ name }} 指南

{{ name }} 学习路径

操作

输入搜索词以在 GitHub 文档中找到它。

包 - GitHub 文档

使用 REST API 与 GitHub Packages 交互。

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

快速入门

关于 GitHub 的 API

REST API 中的资源

API 版本

媒体类型

身份验证

确保 API 凭据安全

故障排除

OpenAPI 描述

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

细化 PAT 的终结点

GitHub 应用的权限

细化 PAT 的权限

重大更改

概述

使用 API

使用 JavaScript 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

集成者最佳做法

入门 - Git 数据库

开始 - 检查

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行程序

变量

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

市场

OAuth 授权

Webhook

应用

计费

分支

受保护的分支

检查运行

检查套件

检查

行为准则

Codes of conduct

代码扫描

Codespaces

组织

组织机密

存储库机密

用户机密

协作者

邀请

提交

提交注释

提交状态

Copilot for Business

Copilot

警报

Dependabot

依赖项检查

依赖项提交

软件材料清单 (SBOM)

依赖项关系图

部署密钥

部署分支策略

部署

环境

保护规则

部署状态

表情符号

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

存储库

用户

交互

问题

受理人

里程碑

时间线

许可证

Markdown

元数据

社区

统计信息

交通

指标

源导入

迁移

阻止用户

成员

外部协作者

个人访问令牌

规则

安全经理

Boards

卡片

Projects (classic)

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

搜索

机密扫描

存储库安全公告

安全通知

Teams

讨论评论

讨论

电子邮件

关注者

GPG 密钥

Git SSH 密钥

SSH 签名密钥

社交帐户

存储库 Webhook 配置

存储库 Webhook 交付

存储库 Webhook

仓库 web 挂钩

hello_docker

goodbye_docker

Package

Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
To use this endpoint, you must authenticate using an access token with the <code>read:packages</code> scope.

The organization name. The name is not case sensitive.

Get list of conflicting packages during Docker migration for organization

Lists packages in an organization readable by the user.
To use this endpoint, you must authenticate using an access token with the <code>read:packages</code> scope. If the <code>package_type</code> belongs to a registry that only supports repository-scoped permissions, your token must also include the <code>repo</code> scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages">About permissions for GitHub Packages</a>."

The type of supported package. Packages in GitHub's Gradle registry have the type <code>maven</code>. Docker images pushed to GitHub's Container registry (<code>ghcr.io</code>) have the type <code>container</code>. You can use the type <code>docker</code> to find images that were pushed to GitHub's Docker registry (<code>docker.pkg.github.com</code>), even if these have now been migrated to the Container registry.

package_type

The selected visibility of the packages. This parameter is optional and only filters an existing result set.
The <code>internal</code> visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems <code>internal</code> is synonymous with <code>private</code>.
For the list of GitHub Packages registries that support granular permissions, see "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages">About permissions for GitHub Packages</a>."

visibility

Page number of the results to fetch.

page

The number of results per page (max 100).

per_page

The value of <code>per_page</code> multiplied by <code>page</code> cannot be greater than 10000.

List packages for an organization

Gets a specific package in an organization.
To use this endpoint, you must authenticate using an access token with the <code>read:packages</code> scope. If the <code>package_type</code> belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the <code>repo</code> scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages">About permissions for GitHub Packages</a>."

package_name

Get a package for an organization

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.
To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the <code>read:packages</code> and <code>delete:packages</code> scopes. In addition:
<ul>
<li>If the <code>package_type</code> belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the <code>repo</code> scope. For the list of these registries, see "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages">About permissions for GitHub Packages</a>."</li>
<li>If the <code>package_type</code> 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 "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages">About permissions for GitHub Packages</a>."</li>
</ul>

Delete a package for an organization

Restores an entire package in an organization.
You can restore a deleted package under the following conditions:
<ul>
<li>The package was deleted within the last 30 days.</li>
<li>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.</li>
</ul>
To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the <code>read:packages</code> and <code>write:packages</code> scopes. In addition:
<ul>
<li>If the <code>package_type</code> belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the <code>repo</code> scope. For the list of these registries, see "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages">About permissions for GitHub Packages</a>."</li>
<li>If the <code>package_type</code> 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 "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages">About permissions for GitHub Packages</a>."</li>
</ul>

token

Restore a package for an organization

1.0.4

Lists package versions for a package owned by an organization.
If the <code>package_type</code> belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the <code>repo</code> scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "<a href="https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages">About permissions for GitHub Packages</a>."

List package versions for a package owned by an organization