跳到主要内容
GitHub 文档
版本:
免费版、专业版和团队版
搜索 GitHub 文档
搜索
选择语言:当前语言为英语
打开搜索栏
关闭搜索栏
打开菜单
打开侧边栏
REST API
/
仓库
首页
REST API
API 版本:
2022-11-28 (最新)
快速入门
关于 REST API
关于 REST API
比较 GitHub 的 API
API 版本
重大更改
OpenAPI 描述
使用 REST API
入门
速率限制
分页
库
最佳实践
故障排除
时区
CORS 和 JSONP
问题事件类型
GitHub 事件类型
身份验证
身份验证
保护 API 凭据安全
GitHub App 安装令牌的端点
GitHub App 用户令牌的端点
细粒度 PAT 的端点
GitHub Apps 的权限
细粒度 PAT 的权限
指南
使用 JavaScript 的脚本
使用 Ruby 的脚本
查找用户的资源
交付部署
将数据呈现为图表
使用评论
构建 CI 服务器
入门 - Git 数据库
入门 - 检查
加密密钥
操作
工件
缓存
OIDC
权限
密钥
自托管运行器组
自托管运行器
变量
工作流作业
工作流运行
工作流
活动
事件
Feed
通知
加星标
关注
应用
GitHub Apps
安装
市场
OAuth 授权
Webhook
计费
计费
分支
分支
受保护的分支
检查
检查运行
检查套件
课堂
课堂
代码扫描
代码扫描
代码安全设置
配置
行为准则
行为准则
Codespaces
Codespaces
组织
组织密钥
机器
仓库密钥
用户密钥
协作者
协作者
邀请
提交
提交
提交评论
提交状态
Copilot
Copilot 指标
Copilot 使用情况
Copilot 用户管理
Dependabot
警报
密钥
依赖关系图
依赖性审查
依赖性提交
软件物料清单 (SBOM)
部署密钥
部署密钥
部署
部署分支策略
部署
环境
保护规则
部署状态
表情符号
表情符号
Gist
Gist
评论
Git 数据库
Blob
提交
引用
标签
树
.gitignore
.gitignore
交互
组织
仓库
用户
问题
问题
指派者
评论
事件
标签
里程碑
时间线
许可证
许可证
Markdown
Markdown
元数据
元数据
指标
社区
统计数据
流量
迁移
组织
源端点
用户
组织
API 洞察
阻止用户
自定义属性
成员
组织角色
组织
外部协作者
个人访问令牌
规则套件
规则
安全管理员
Webhook
包
包
页面
页面
项目(经典)
看板
卡片
协作者
列
拉取请求
拉取请求
审查评论
审查请求
审查
速率限制
速率限制
反应
反应
发行版
发行版
发行版资源
仓库
自动链接
内容
自定义属性
分支
仓库
规则套件
规则
标签
Webhook
搜索
搜索
密钥扫描
密钥扫描
安全公告
全局安全公告
仓库安全公告
团队
团队
讨论评论
讨论
成员
用户
证明
阻止用户
电子邮件
关注者
GPG 密钥
Git SSH 密钥
社交账号
SSH 签名密钥
用户
REST API 现在已版本化。
更多信息,请参阅“
关于 API 版本化
”。
REST API
/
仓库
仓库的 REST API 端点
使用 REST API 创建、管理和控制公共和私有 GitHub 仓库的工作流程。
仓库的 REST API 端点
列出组织仓库
创建一个组织仓库
获取仓库
更新仓库
删除仓库
列出仓库活动
创建一个证明
列出证明
检查是否为仓库启用了自动安全修复
启用自动安全修复
禁用自动安全修复
列出 CODEOWNERS 错误
列出仓库贡献者
创建一个仓库调度事件
列出仓库语言
检查是否为仓库启用了私有漏洞报告
为仓库启用私有漏洞报告
为仓库禁用私有漏洞报告
列出仓库标签
列出仓库团队
获取所有仓库主题
替换所有仓库主题
转移仓库
检查是否为仓库启用了漏洞警报
启用漏洞警报
禁用漏洞警报
使用模板创建仓库
列出公共仓库
列出认证用户的仓库
为认证用户创建一个仓库
列出用户的仓库
仓库自动链接的 REST API 端点
获取仓库的所有自动链接
为仓库创建一个自动链接引用
获取仓库的自动链接引用
从仓库中删除自动链接引用
仓库内容的 REST API 端点
获取仓库内容
创建或更新文件内容
删除文件
获取仓库自述文件
获取目录的仓库自述文件
下载仓库存档(tar)
下载仓库存档(zip)
自定义属性的 REST API 端点
获取仓库的所有自定义属性值
创建或更新仓库的自定义属性值
Fork 的 REST API 端点
列出 Fork
创建一个 Fork
规则套件的 REST API 端点
列出仓库规则套件
获取仓库规则套件
规则的 REST API 端点
获取分支的规则
获取所有仓库规则集
创建一个仓库规则集
获取仓库规则集
更新仓库规则集
删除仓库规则集
仓库标签的 REST API 端点
即将关闭 - 列出仓库的标签保护状态
即将关闭 - 为仓库创建标签保护状态
即将关闭 - 删除仓库的标签保护状态
仓库 Webhook 的 REST API 端点
列出仓库 Webhook
创建一个仓库 Webhook
获取仓库 Webhook
更新仓库 Webhook
删除仓库 Webhook
获取仓库的 Webhook 配置
更新仓库的 Webhook 配置
列出仓库 Webhook 的交付
获取仓库 Webhook 的交付
重新交付仓库 Webhook 的交付
Ping 仓库 Webhook
测试推送仓库 Webhook