仓库与文件内容
查询和管理仓库，读取 README、文件与目录内容，并通过内容接口更新文件，适合代码归档和配置自动化。
接入要求私有数据和写入操作需相应仓库权限；具体端点支持的令牌类型、Contents 等权限及分支规则需要逐项核对。
读取仓库中的文件站内调用手册 · 参数、代码与排错开发与云服务 / GitHub REST API & Webhooks
GitHub
通过 GitHub.com REST API 管理已获授权的仓库、Issues、拉取请求和 Actions，并用 Webhooks 接收事件。适合开发协作工具、项目看板和 CI 集成；此条目不覆盖 Copilot、Models 或自托管 Enterprise Server 的全部接口。
01 / CAPABILITIES
开放功能
核心接口调用手册
3 个场景覆盖读取仓库文件、创建 Issue、列出拉取请求三个常见场景，采用细粒度个人令牌。未包含 GitHub App 安装令牌签发、代码推送和自动合并。
Issues 与任务协作
创建和维护 Issues、评论、标签、指派和里程碑，把外部工单与研发任务关联。
接入要求需目标仓库及相关 Issues 权限；仓库是否启用 Issues 和可执行操作的角色仍会影响结果。
把外部反馈创建为 Issue站内调用手册 · 参数、代码与排错拉取请求与代码评审
查询、创建和更新拉取请求，读取改动与评审，按许可执行合并，适合评审助手和变更追踪。
接入要求合并需对应权限，并遵守目标仓库配置的分支保护、检查与评审规则。
查询待处理拉取请求站内调用手册 · 参数、代码与排错Actions 工作流管理
查询工作流与运行状态、获取日志和产物，触发支持的手动工作流，取消或重新运行任务。
接入要求需要端点要求的 Actions 权限；仓库工作流配置和组织策略仍适用，触发运行可能消耗分钟与存储额度。
仓库与协作事件推送
订阅代码推送、拉取请求等事件，将事件数据推送至自己的服务，减少反复轮询。
接入要求配置可接收请求的 webhook URL、所需事件和资源权限；按官方建议设置 secret 并校验投递，不会自动获得其他仓库事件。
02 / REQUIREMENTS
接入条件
- 适用主体
- 开发工具作者、研发协作平台开发者、CI 与运维自动化开发者
- 接入方式
- 细粒度或 classic 个人访问令牌（PAT） / GitHub App 的 JWT、安装令牌或用户令牌 / OAuth App 用户授权 / Actions 内置 GITHUB_TOKEN
- 申请概况
- 个人工具可使用 PAT；服务多个账号或组织通常使用 GitHub App 并由目标账号安装授权。
- 准备 GitHub 账号和可控制的测试仓库；为组织创建 App 需拥有组织或获授 App 管理权限。
- 个人脚本优先核对细粒度 PAT 的端点兼容性、仓库范围和权限；面向多个用户或组织的应用优先评估 GitHub App。
- GitHub App 先注册、选择最小权限与可安装范围，再由目标账号安装；安装身份与代用户身份分别配置，不共用为一个无限权限凭证。
- OAuth 或 App 用户授权按实际流程配置回调；需要事件时配置 webhook URL、secret 和事件订阅。
- 组织若启用 SAML SSO，classic PAT 需单独授权，细粒度 PAT 在创建时授权；仍要符合组织的访问策略。
- 使用前核对 GitHub.com 的适用主体、所在地与贸易管制条款，API 不提供规避账号限制的访问方式。
03 / GET STARTED
开通步骤
- 01
确定个人工具或多账号应用
个人自动化选择最小权限 PAT；需要在其他账号或组织使用时，先设计 GitHub App 的安装和授权范围。
- 02
注册并配置授权
在 Developer settings 创建应用或令牌，核对目标仓库、读写权限、回调和 webhook 配置。
- 03
从测试仓库的读取开始
先验证仓库和 Issues 读取，再在自己控制的测试分支验证文件、评论等写入；真实操作会保留在仓库中。
- 04
检查事件与资源费用
核对 webhook 投递、限流响应头和授权撤销；触发 Actions 前确认 runner、套餐额度和费用预算。
04 / COSTS & LIMITS
费用、边界与测试方式
费用概况
核心 REST 接入与使用的产品资源分开评估；Actions 的免费范围、含量和超额费用有明确条件。
- 所读官方资料未列出核心 REST API 的统一按请求单价；GitHub Free 可用于基础仓库与协作，但 API 调用仍受主要和次级限流约束。
- GitHub Actions 的公有仓库使用标准 GitHub 托管 runner 有免费范围；larger runners 始终收费，不能套用公有仓库免费结论。
- 私有仓库按账号套餐提供托管 runner 分钟及存储含量，超额运行按操作系统和算力对应的 runner 分钟计费，费用归仓库所有者。
- Actions 产物与缓存等存储按小时累计 GB-Hours 并形成账单；产物与 Packages 的共享额度、缓存额度需分开核对，删除后不会抹去已累计用量。
- 套餐席位和其他产品费用另算；没有有效付款方式时，超出含量后的 Actions 使用可能被阻止。
使用范围与限制
- 此条目以 GitHub.com 核心 REST API 和 Webhooks 为范围，不代表所有 GitHub 付费产品或企业管理接口均已开放。
- 令牌权限、App 安装仓库、用户自身角色及仓库规则共同决定可操作范围；凭证本身不会额外授予仓库规则的绕过权。
- 主要限流随认证身份而变，搜索和次级限流另算；按响应头和 403/429 指引退避，不能用多个凭证规避限制。
- 公开数据有可免认证读取的接口，但额度较低；公开可读不等于允许无约束采集、转售或滥用。
- 测试仓库与正式仓库使用同一服务；在测试仓库触发 Actions 仍可能产生真实资源用量。
- GitHub.com 的地区与贸易限制不能用 Copilot 或 Enterprise Server 的产品清单替代判断。
如何进行开发测试
- 正式服务：REST API 和 Webhooks 连接实际的 GitHub.com 账号、仓库与组织。
- 开发验证：建议建立独立测试仓库、分支及测试 App 安装范围；写入、评论和 workflow dispatch 都会产生实际效果。
- Actions：工作流中的 GITHUB_TOKEN 有单独权限配置，不应与本地 PAT 或 App 安装令牌视为同一身份。
- 本次未登录开发后台、安装 App 或调用 API；未确认覆盖这些功能的统一隔离沙箱。
接入前再确认
- 只介绍 GitHub.com 核心 REST API、Webhooks 和相关 Actions 管理能力。
- 核心 REST 未发现统一按次价目，不把 API 限流解释为付费资源的免费额度。
- GitHub Apps 后台为登录入口，未登录或验证任何账号实际可用权限。
05 / OFFICIAL SOURCES
官方资料
以下资料用于核对本页内容。申请与使用时，请以对应接口的最新规则为准。
- 01GitHub 仓库与内容 REST API已核对官方资料 · 2026-10-15
- 02GitHub Issues REST API已核对官方资料 · 2026-10-15
- 03GitHub Pull Requests REST API已核对官方资料 · 2026-10-15
- 04GitHub Actions REST API已核对官方资料 · 2026-10-15
- 05GitHub Webhooks 的用途与资源范围已核对官方资料 · 2026-10-15
- 06GitHub REST API 认证方式已核对官方资料 · 2026-10-15
- 07GitHub App 的三种身份已核对官方资料 · 2026-10-15
- 08注册 GitHub App 与配置权限已核对官方资料 · 2026-10-15
- 09GitHub REST API 主要与次级限流已核对官方资料 · 2026-10-15
- 10GitHub 套餐与产品费用已核对官方资料 · 2026-10-15
- 11GitHub Actions 用量与账单已核对官方资料 · 2026-10-15
- 12GitHub 服务条款中的 API 使用规则已核对官方资料 · 2026-10-15
- 13GitHub 与贸易管制已核对官方资料 · 2026-10-15
- 14GitHub 分支保护与合并条件已核对官方资料 · 2026-10-15
- 15GitHub Apps 设置入口官方入口 · 细则待复核 · 2026-10-15
官方文档核对，未进行接口实测
最近核验 2026-10-15 · 查看核验说明
最近核验 2026-10-15 · 查看核验说明
