跳到主要内容
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应用程序安装令牌的端点
GitHub应用程序用户令牌的端点
细粒度PAT的端点
GitHub应用程序的权限
细粒度PAT的权限
辅助线
使用JavaScript编写脚本
用Ruby编写脚本
发现用户的资源
交付部署
将数据呈现为图形
使用评论
构建CI服务器
入门-Git数据库
入门-检查
加密机密
行动
人工产品
隐藏物
石油天然气开发公司
权限
秘密
自我托管的跑步者
变量
工作流作业
工作流运行
工作流
活动
事件
喂养
通知
主演
看
应用程序
GitHub应用程序
安装
市场
OAuth授权
Webhooks(网钩)
演员表
演员表
分支机构
分支机构
受保护的分支机构
检查
检查管路
检查套房
教室
教室
代码扫描
代码扫描
代码安全设置
配置
行为准则
行为准则
代码空间
代码空间
组织
组织机密
机器
存储库机密
用户机密
合作者
合作者
邀请
提交
提交
提交评论
提交状态
副驾驶员
副驾驶使用
副驾驶员用户管理
依赖者
警报
秘密
依赖关系图
依赖性审查
依赖关系提交
软件物料清单(SBOM)
部署密钥
部署密钥
部署
部署分支策略
部署
环境
保护规则
部署状态
表情符号
表情符号
主旨
主旨
评论
Git数据库
水滴
提交
工具书类
标签
树
基蒂格诺尔
基蒂格诺尔
互动
组织
存储库
用户
问题
问题
受让人
评论
事件
标签
里程碑
时间表
许可证
许可证
降价
降价
元
元
韵律学
社区
统计
交通
迁移
组织
源终结点
用户
组织
阻止用户
自定义属性
成员
组织角色
组织
外部合作者
个人访问令牌
规则套件
规则
安全经理
Webhooks(网钩)
包装
包装
页
页
项目(经典)
董事会
卡
合作者
柱
Pull请求
Pull请求
评审意见
审查请求
评论
费率限制
费率限制
反应
反应
发布
发布
释放资产
存储库
自动链接
目录
自定义属性
叉子
存储库
规则套件
规则
标签
Webhooks(网钩)
搜索
搜索
秘密扫描
秘密扫描
安全警告
全球安全咨询
存储库安全建议
团队
团队
讨论意见
讨论
成员
用户
证明
阻止用户
电子邮件
追随者
GPG键
Git SSH密钥
社会账户
SSH签名密钥
用户
REST API现在已经过版本控制。
有关详细信息,请参阅“
关于API版本控制
."
REST API
/
行动
GitHub操作的REST API端点
使用REST API与组织或存储库的GitHub操作交互。
GitHub操作工件的REST API端点
列出存储库的工件
获取工件
删除工件
下载工件
列出工作流运行工件
GitHub操作缓存的REST API端点
获取组织的GitHub操作缓存使用情况
列出组织使用GitHub操作缓存的存储库
获取存储库的GitHub操作缓存使用率
列出存储库的GitHub操作缓存
删除存储库的GitHub操作缓存(使用缓存键)
删除存储库的GitHub操作缓存(使用缓存ID)
GitHub操作OIDC的REST API端点
获取组织的OIDC主题声明的自定义模板
为组织的OIDC主题声明设置自定义模板
获取存储库OIDC主题声明的自定义模板
为存储库的OIDC主题声明设置自定义模板
GitHub操作权限的REST API端点
获取组织的GitHub操作权限
设置组织的GitHub操作权限
列出组织中为GitHub操作启用的选定存储库
为组织中的GitHub操作设置所选存储库
为组织中的GitHub操作启用选定的存储库
为组织中的GitHub操作禁用选定的存储库
获取组织允许的操作和可重用的工作流
为组织设置允许的操作和可重用的工作流
获取组织的默认工作流权限
设置组织的默认工作流权限
获取存储库的GitHub操作权限
设置存储库的GitHub操作权限
获取存储库外部工作流的访问级别
设置存储库外部工作流的访问级别
获取存储库的允许操作和可重用工作流
为存储库设置允许的操作和可重用的工作流
获取存储库的默认工作流权限
设置存储库的默认工作流权限
GitHub操作机密的REST API端点
列出组织机密
获取组织公钥
获取组织机密
创建或更新组织机密
删除组织机密
列出组织机密的选定存储库
为组织机密设置选定的存储库
将所选存储库添加到组织机密
从组织机密中删除选定的存储库
列出存储库组织机密
列出存储库机密
获取存储库公钥
获取存储库机密
创建或更新存储库机密
删除存储库机密
列出环境机密
获取环境公钥
获取环境秘密
创建或更新环境机密
删除环境机密
用于自托管运行程序的REST API端点
列出组织的自托管跑步者
列出组织的跑步者应用程序
为组织的即时跑步者创建配置
为组织创建注册令牌
为组织创建删除令牌
为组织安排一名自我托管的跑步者
从组织中删除自托管跑步者
列出组织的自托管跑步者的标签
为组织的自托管跑步者添加自定义标签
为组织的自托管跑步者设置自定义标签
从组织的自托管跑步者中删除所有自定义标签
从组织的自托管运行程序中删除自定义标签
列出存储库的自托管运行程序
列出存储库的运行程序应用程序
为存储库的实时运行程序创建配置
为存储库创建注册令牌
为存储库创建删除令牌
获取存储库的自托管跑步者
从存储库中删除自托管跑步者
为存储库的自托管运行程序列出标签
为存储库的自托管运行器添加自定义标签
为存储库的自托管跑步者设置自定义标签
从存储库的自托管运行器中删除所有自定义标签
从存储库的自托管运行器中删除自定义标签
GitHub操作变量的REST API端点
列出组织变量
创建组织变量
获取组织变量
更新组织变量
删除组织变量
列出组织变量的选定存储库
为组织变量设置选定的存储库
将所选存储库添加到组织变量
从组织变量中删除选定的存储库
列出存储库组织变量
列出存储库变量
创建存储库变量
获取存储库变量
更新存储库变量
删除存储库变量
列出环境变量
创建环境变量
获取环境变量
更新环境变量
删除环境变量
工作流作业的REST API端点
获取工作流运行的作业
下载工作流运行的作业日志
列出工作流运行尝试的作业
列出工作流运行的作业
工作流运行的REST API端点
从工作流运行中重新运行作业
列出存储库的工作流运行情况
运行工作流
删除工作流运行
获取工作流运行的审阅历史记录
批准fork-pull请求的工作流运行
获取工作流运行尝试
下载工作流运行尝试日志
取消工作流运行
查看工作流运行的自定义部署保护规则
强制取消工作流运行
下载工作流运行日志
删除工作流运行日志
获取工作流运行的挂起部署
查看工作流运行的挂起部署
重新运行工作流
从工作流运行中重新运行失败的作业
获取工作流运行使用情况
列出工作流运行的工作流
工作流的REST API端点
列出存储库工作流
获取工作流
禁用工作流
创建工作流调度事件
启用工作流
获取工作流使用情况