跳至主要内容
GitHub 文档
版本:
免费、专业版和团队版
搜索 GitHub 文档
REST API
/
Actions
首页
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
权限
密钥
自托管运行器
变量
工作流作业
工作流运行
工作流
活动
事件
提要
通知
主演
观看
应用
GitHub 应用
安装
市场
OAuth 授权
Webhook
计费
计费
分支
分支
受保护的分支
检查
检查运行
检查套件
课堂
课堂
代码扫描
代码扫描
行为准则
行为准则
Codespaces
Codespaces
组织
组织机密
机器
仓库机密
用户机密
协作者
协作者
邀请
提交
提交
提交评论
提交状态
Copilot
Copilot 使用情况
Copilot 用户管理
Dependabot
警报
密钥
依赖关系图
依赖关系审查
依赖关系提交
软件物料清单 (SBOM)
部署密钥
部署密钥
部署
部署分支策略
部署
环境
保护规则
部署状态
表情符号
表情符号
Gists
Gists
评论
Git 数据库
Blob
提交
引用
标签
树
Gitignore
Gitignore
交互
组织
仓库
用户
问题
问题
指派人
评论
事件
标签
里程碑
时间线
许可证
许可证
Markdown
Markdown
元数据
元数据
指标
社区
统计数据
流量
迁移
组织
源端点
用户
组织
屏蔽用户
自定义属性
成员
组织角色
组织
外部协作者
个人访问令牌
规则套件
规则
安全管理员
Webhook
包
包
页面
页面
项目(经典)
看板
卡片
协作者
列
拉取请求
拉取请求
审查评论
审查请求
审查
速率限制
速率限制
反应
反应
发布
发布
发布资产
仓库
自动链接
内容
自定义属性
分支
仓库
规则套件
规则
标签
Webhook
搜索
搜索
秘密扫描
秘密扫描
安全建议
全局安全建议
仓库安全建议
团队
团队
讨论评论
讨论
成员
用户
用户
屏蔽用户
电子邮件
关注者
GPG 密钥
Git SSH 密钥
SSH 签名密钥
社交帐户
REST API 现在已版本化。
有关更多信息,请参阅 "
关于 API 版本控制
."
REST API
/
Actions
GitHub Actions 的 REST API 端点
使用 REST API 与组织或仓库的 GitHub Actions 进行交互。
GitHub Actions 工件的 REST API 端点
列出仓库中的工件
获取工件
删除工件
下载工件
列出工作流运行工件
GitHub Actions 缓存的 REST API 端点
获取组织的 GitHub Actions 缓存使用情况
列出组织中使用 GitHub Actions 缓存的仓库
获取仓库的 GitHub Actions 缓存使用情况
列出仓库的 GitHub Actions 缓存
删除仓库的 GitHub Actions 缓存(使用缓存键)
删除仓库的 GitHub Actions 缓存(使用缓存 ID)
GitHub Actions OIDC 的 REST API 端点
获取组织的 OIDC 主题声明的自定义模板
设置组织的 OIDC 主题声明的自定义模板
获取仓库的 OIDC 主题声明的自定义模板
设置仓库的 OIDC 主题声明的自定义模板
GitHub Actions 权限的 REST API 端点
获取组织的 GitHub Actions 权限
设置组织的 GitHub Actions 权限
列出组织中启用了 GitHub Actions 的选定仓库
设置组织中启用了 GitHub Actions 的选定仓库
在组织中启用选定仓库的 GitHub Actions
在组织中禁用选定仓库的 GitHub Actions
获取组织允许的操作和可重用工作流
设置组织允许的操作和可重用工作流
获取组织的默认工作流权限
设置组织的默认工作流权限
获取仓库的 GitHub Actions 权限
设置仓库的 GitHub Actions 权限
获取仓库外部工作流的访问级别
设置仓库外部工作流的访问级别
获取仓库允许的操作和可重用工作流
设置仓库允许的操作和可重用工作流
获取仓库的默认工作流权限
设置仓库的默认工作流权限
GitHub Actions 机密的 REST API 端点
列出组织机密
获取组织公钥
获取组织机密
创建或更新组织机密
删除组织机密
列出组织机密的选定仓库
设置组织机密的选定仓库
将选定的仓库添加到组织机密
从组织机密中删除选定的仓库
列出仓库组织机密
列出仓库机密
获取仓库公钥
获取仓库机密
创建或更新仓库机密
删除仓库机密
列出环境机密
获取环境公钥
获取环境机密
创建或更新环境机密
删除环境机密
自托管运行器的 REST API 端点
列出组织的自托管运行器
列出组织的运行器应用程序
为组织创建即时运行器的配置
为组织创建注册令牌
为组织创建删除令牌
获取组织的自托管运行器
从组织中删除自托管运行器
列出组织自托管运行器的标签
为组织的自托管运行器添加自定义标签
为组织的自托管运行器设置自定义标签
从组织的自托管运行器中删除所有自定义标签
从组织的自托管运行器中删除自定义标签
列出仓库的自托管运行器
列出仓库的运行器应用程序
为仓库创建即时运行器的配置
为仓库创建注册令牌
为仓库创建删除令牌
获取仓库的自托管运行器
从仓库中删除自托管运行器
列出仓库自托管运行器的标签
为仓库的自托管运行器添加自定义标签
为仓库的自托管运行器设置自定义标签
从仓库的自托管运行器中删除所有自定义标签
从仓库的自托管运行器中删除自定义标签
GitHub Actions 变量的 REST API 端点
列出组织变量
创建组织变量
获取组织变量
更新组织变量
删除组织变量
列出组织变量的选定仓库
为组织变量设置选定仓库
将选定的仓库添加到组织变量
从组织变量中移除选定的仓库
列出仓库组织变量
列出仓库变量
创建仓库变量
获取仓库变量
更新仓库变量
删除仓库变量
列出环境变量
创建环境变量
获取环境变量
更新环境变量
删除环境变量
工作流作业的 REST API 端点
获取工作流运行的作业
下载工作流运行的作业日志
列出工作流运行尝试的作业
列出工作流运行的作业
工作流运行的 REST API 端点
重新运行工作流运行中的作业
列出仓库的工作流运行
获取工作流运行
删除工作流运行
获取工作流运行的审查历史记录
批准分支拉取请求的工作流运行
获取工作流运行尝试
下载工作流运行尝试日志
取消工作流运行
审查工作流运行的自定义部署保护规则
强制取消工作流运行
下载工作流运行日志
删除工作流运行日志
获取工作流运行的待处理部署
审查工作流运行的待处理部署
重新运行工作流
重新运行工作流运行中失败的作业
获取工作流运行使用情况
列出工作流的工作流运行
工作流的 REST API 端点
列出仓库工作流
获取工作流
禁用工作流
创建工作流调度事件
启用工作流
获取工作流使用情况