Skip to main content
GitHub 文档
Version:
Enterprise Server 3.13
搜索 GitHub Docs
Search
Select language: current language is Simplified Chinese
Open Search Bar
Close Search Bar
Open Menu
Open Sidebar
REST API
/
操作
主页
REST API
API Version:
2022-11-28 (latest)
快速入门
REST API 简介
REST API 简介
比较 GitHub 的 API
API 版本
重大更改
OpenAPI 描述
使用 REST API
入门
速率限制
分页
Libraries
最佳做法
故障排除
时区
CORS 与 JSONP
议题事件类型
GitHub 事件类型
身份验证
身份验证
确保 API 凭据安全
适用于 GitHub Apps 安装令牌的终结点
适用于 GitHub Apps 用户令牌的终结点
细化 PAT 的终结点
GitHub 应用的权限
细化 PAT 的权限
Guides
使用 JavaScript 编写脚本
使用 Ruby 编写脚本
为用户发现资源
交付部署
将数据渲染为图形
处理注释
构建 CI 服务器
入门 - Git 数据库
开始 - 检查
加密机密
操作
Artifacts
缓存
OIDC
权限
机密
自托管运行器组
自托管运行程序
变量
工作流程作业
工作流运行
工作流
活动
事件
源
通知
标星
关注中
公告横幅
组织
应用
GitHub Apps
安装
OAuth 授权
Webhook
计费
计费
分支
分支
受保护的分支
检查
检查运行
检查套件
代码扫描
代码扫描
行为准则
行为准则
协作者
协作者
邀请
提交
提交
提交注释
提交状态
Dependabot
警报
机密
依赖关系图
依赖项检查
依赖项提交
软件材料清单 (SBOM)
部署密钥
部署密钥
部署
部署分支策略
部署
环境
保护规则
部署状态
表情符号
表情符号
企业管理
管理统计
公告
审核日志
计费
代码安全性和分析
全局 Webhook
LDAP
许可证
管理 GHES
管理控制台
组织预接收挂钩
组织
预接收环境
预接收挂钩
存储库预接收挂钩
SCIM
用户
Gists
Gists
评论
Git 数据库
Blob
提交
参考
标记
Trees
Gitignore
Gitignore
问题
受理人
评论
事件
问题
标签
里程碑
时间线
许可证
许可证
Markdown
Markdown
元数据
元数据
指标
统计信息
迁移
组织
用户
OAuth 应用授权
OAuth 应用授权
组织
自定义属性
自定义角色
成员
组织
外部协作者
个人访问令牌
规则套件
规则
安全管理员
Webhook
包
包
页
页
Projects (classic)
Boards
卡片
协作者
列
拉取请求
拉取请求
评价注释
审查请求
审阅
速率限制
速率限制
反应
反应
发行版本
发行版本
发布资产
存储库
自动链接
目录
自定义属性
前叉
Git LFS
存储库
规则套件
规则
标记
Webhook
Search
Search
机密扫描
机密扫描
安全通知
全局安全公告
Teams
Teams
讨论评论
讨论
外部组
成员
用户
电子邮件
关注者
GPG 密钥
Git SSH 密钥
社交帐户
SSH 签名密钥
用户
REST API 现已经过版本控制。
有关详细信息,请参阅“
关于 API 版本控制
”。
REST API
/
操作
GitHub Actions 的 REST API 终结点
使用 REST API 与组织或存储库的 GitHub Actions 交互。
GitHub Actions 构件的 REST API 终结点
List artifacts for a repository
Get an artifact
Delete an artifact
Download an artifact
List workflow run artifacts
GitHub Actions 缓存的 REST API 终结点
Get GitHub Actions cache usage for an enterprise
Get GitHub Actions cache usage policy for an enterprise
Set GitHub Actions cache usage policy for an enterprise
Get GitHub Actions cache usage for an organization
List repositories with GitHub Actions cache usage for an organization
Get GitHub Actions cache usage for a repository
Get GitHub Actions cache usage policy for a repository
Set GitHub Actions cache usage policy for a repository
List GitHub Actions caches for a repository
Delete GitHub Actions caches for a repository (using a cache key)
Delete a GitHub Actions cache for a repository (using a cache ID)
GitHub Actions OIDC 的 REST API 终结点
Get the customization template for an OIDC subject claim for an organization
Set the customization template for an OIDC subject claim for an organization
Get the customization template for an OIDC subject claim for a repository
Set the customization template for an OIDC subject claim for a repository
GitHub Actions 权限的 REST API 终结点
Get GitHub Actions permissions for an enterprise
Set GitHub Actions permissions for an enterprise
List selected organizations enabled for GitHub Actions in an enterprise
Set selected organizations enabled for GitHub Actions in an enterprise
Enable a selected organization for GitHub Actions in an enterprise
Disable a selected organization for GitHub Actions in an enterprise
Get allowed actions for an enterprise
Set allowed actions for an enterprise
Get default workflow permissions for an enterprise
Set default workflow permissions for an enterprise
Get GitHub Actions permissions for an organization
Set GitHub Actions permissions for an organization
List selected repositories enabled for GitHub Actions in an organization
Set selected repositories enabled for GitHub Actions in an organization
Enable a selected repository for GitHub Actions in an organization
Disable a selected repository for GitHub Actions in an organization
Get allowed actions for an organization
Set allowed actions for an organization
Get default workflow permissions for an organization
Set default workflow permissions for an organization
Get GitHub Actions permissions for a repository
Set GitHub Actions permissions for a repository
Get the level of access for workflows outside of the repository
Set the level of access for workflows outside of the repository
Get allowed actions for a repository
Set allowed actions for a repository
Get default workflow permissions for a repository
Set default workflow permissions for a repository
GitHub Actions 机密的 REST API 终结点
List organization secrets
Get an organization public key
Get an organization secret
Create or update an organization secret
Delete an organization secret
List selected repositories for an organization secret
Set selected repositories for an organization secret
Add selected repository to an organization secret
Remove selected repository from an organization secret
List repository organization secrets
List repository secrets
Get a repository public key
Get a repository secret
Create or update a repository secret
Delete a repository secret
List environment secrets
Get an environment public key
Get an environment secret
Create or update an environment secret
Delete an environment secret
自托管运行器组的 REST API 终结点
List self-hosted runner groups for an enterprise
Create a self-hosted runner group for an enterprise
Get a self-hosted runner group for an enterprise
Update a self-hosted runner group for an enterprise
Delete a self-hosted runner group from an enterprise
List organization access to a self-hosted runner group in an enterprise
Set organization access for a self-hosted runner group in an enterprise
Add organization access to a self-hosted runner group in an enterprise
Remove organization access to a self-hosted runner group in an enterprise
List self-hosted runners in a group for an enterprise
Set self-hosted runners in a group for an enterprise
Add a self-hosted runner to a group for an enterprise
Remove a self-hosted runner from a group for an enterprise
List self-hosted runner groups for an organization
Create a self-hosted runner group for an organization
Get a self-hosted runner group for an organization
Update a self-hosted runner group for an organization
Delete a self-hosted runner group from an organization
List repository access to a self-hosted runner group in an organization
Set repository access for a self-hosted runner group in an organization
Add repository access to a self-hosted runner group in an organization
Remove repository access to a self-hosted runner group in an organization
List self-hosted runners in a group for an organization
Set self-hosted runners in a group for an organization
Add a self-hosted runner to a group for an organization
Remove a self-hosted runner from a group for an organization
自托管运行器的 REST API 终结点
List self-hosted runners for an enterprise
List runner applications for an enterprise
Create configuration for a just-in-time runner for an Enterprise
Create a registration token for an enterprise
Create a remove token for an enterprise
Get a self-hosted runner for an enterprise
Delete a self-hosted runner from an enterprise
List labels for a self-hosted runner for an enterprise
Add custom labels to a self-hosted runner for an enterprise
Set custom labels for a self-hosted runner for an enterprise
Remove all custom labels from a self-hosted runner for an enterprise
Remove a custom label from a self-hosted runner for an enterprise
List self-hosted runners for an organization
List runner applications for an organization
Create configuration for a just-in-time runner for an organization
Create a registration token for an organization
Create a remove token for an organization
Get a self-hosted runner for an organization
Delete a self-hosted runner from an organization
List labels for a self-hosted runner for an organization
Add custom labels to a self-hosted runner for an organization
Set custom labels for a self-hosted runner for an organization
Remove all custom labels from a self-hosted runner for an organization
Remove a custom label from a self-hosted runner for an organization
List self-hosted runners for a repository
List runner applications for a repository
Create configuration for a just-in-time runner for a repository
Create a registration token for a repository
Create a remove token for a repository
Get a self-hosted runner for a repository
Delete a self-hosted runner from a repository
List labels for a self-hosted runner for a repository
Add custom labels to a self-hosted runner for a repository
Set custom labels for a self-hosted runner for a repository
Remove all custom labels from a self-hosted runner for a repository
Remove a custom label from a self-hosted runner for a repository
GitHub Actions 变量的 REST API 终结点
List organization variables
Create an organization variable
Get an organization variable
Update an organization variable
Delete an organization variable
List selected repositories for an organization variable
Set selected repositories for an organization variable
Add selected repository to an organization variable
Remove selected repository from an organization variable
List repository organization variables
List repository variables
Create a repository variable
Get a repository variable
Update a repository variable
Delete a repository variable
List environment variables
Create an environment variable
Get an environment variable
Update an environment variable
Delete an environment variable
工作流作业的 REST API 终结点
Get a job for a workflow run
Download job logs for a workflow run
List jobs for a workflow run attempt
List jobs for a workflow run
工作流运行的 REST API 终结点
Re-run a job from a workflow run
List workflow runs for a repository
Get a workflow run
Delete a workflow run
Get the review history for a workflow run
Get a workflow run attempt
Download workflow run attempt logs
Cancel a workflow run
Review custom deployment protection rules for a workflow run
Force cancel a workflow run
Download workflow run logs
Delete workflow run logs
Get pending deployments for a workflow run
Review pending deployments for a workflow run
Re-run a workflow
Re-run failed jobs from a workflow run
List workflow runs for a workflow
工作流的 REST API 终结点
List repository workflows
Get a workflow
Disable a workflow
Create a workflow dispatch event
Enable a workflow