GitHub Enterprise API logo

GitHub Enterprise API

GitHub Enterprise API

GitHub Enterprise(Cloud + Server)的 REST v3 与 GraphQL v4 API:审计日志、SAML SSO、EMU、按用户/仓库扩展的速率上限

适合什么时候用

速率上限按使用方式分层:PAT 5K/hour、OAuth App 5K/hour/app、GitHub Apps 5K~15K/hour 且按仓库与用户数线性扩展。企业级工作负载用 GitHub Apps 能拿到最高 12,500(GHES)/ 15,000(GHEC)/hour

先注意什么

GHEC 与 GHES 是两套 API 表面,端点覆盖不完全一致。GHES 按版本(3.0~3.8 等)有功能差异,需要按目标实例的版本写代码并 X-GitHub-Api-Version 头锁定

第一步先查

在 github.com/enterprise 起 GHEC 试用或在 enterprise.github.com 申请 GHES 报价。优先用 GitHub Apps 而不是 PAT:在 enterprise 设置里建 App,安装到目标 org,用 installation token 调 API,速率上限直接到 15,000/hour(GHEC)。REST 调用记得带 X-GitHub-Api-Version: 2026-03-10(或保留 2022-11-28 默认)。

认证
oauth
CORS
?
HTTPS
注册
需要
协议
REST, GraphQL
计费
paid

可用率 · 30 天窗口

日常巡检数据收集后将在此处显示。
01

关于这个 API

GitHub Enterprise 是 GitHub 面向企业的两条产品线:Enterprise Cloud (GHEC) 是 github.com 上的企业租户,每席 $21/月(首年);Enterprise Server (GHES) 是自托管版本,按报价销售。API 表面以 REST v3 (api.github.com 或 GHES 实例域名) 和 GraphQL v4 为主,REST 用日期版本头 X-GitHub-Api-Version 路由,当前支持 2026-03-10 与 2022-11-28(24+ 月支持窗口)。鉴权五条路径:unauthenticated(60/hour/IP)、PAT(5,000/hour)、OAuth App(5,000/hour/app)、GitHub Apps installation(基线 5,000/hour,GHEC 15,000/hour,按仓库与用户线性扩展,封顶 12,500 或 15,000)、Actions 内置 GITHUB_TOKEN(标准 1,000/hour/repo、GHEC 15,000/hour/repo)。Enterprise 独享端点包含 audit log API、SAML SSO、SCIM、Enterprise-level webhooks,配 EMU(Enterprise Managed Users)可实现 IdP 主控的身份生命周期。GraphQL 计费按点(read=1、mutation=5),单次最高 900 points/min/endpoint。次要限制有 100 并发、80 content-creating 请求/min(500/hour)、CPU 90s/60s 墙时间窗口。SDK 生态完整:Octokit(JS/Ruby/.NET)、PyGithub、go-github、hub4j 均官方/社区主流维护。

02

你可以做什么

  • 1企业级权限治理:用 audit log API 拉 SSO 登录、仓库权限变更、token 创建事件,对接 SIEM 做合规告警
  • 2大规模 CI/CD:用 GitHub Apps 安装 token 拿到 15,000 req/hour(GHEC)配额,覆盖几百仓的自动化流水线
  • 3EMU 身份治理:通过 IdP 单点接入 SCIM 同步用户与组,所有 GitHub 账号生命周期由 IdP 主控
03

优劣对比

优点

  • 速率上限按使用方式分层:PAT 5K/hour、OAuth App 5K/hour/app、GitHub Apps 5K~15K/hour 且按仓库与用户数线性扩展。企业级工作负载用 GitHub Apps 能拿到最高 12,500(GHES)/ 15,000(GHEC)/hour
  • REST v3 + GraphQL v4 双协议齐全。GraphQL 用点数计费(read=1、mutation=5),同一接口能聚合查询,减少往返;REST 用 X-GitHub-Api-Version 头按日期版本路由
  • Enterprise 独享端点:audit log API、SAML SSO 配置、SCIM、Enterprise-level webhook,配合 IdP 实现完整身份生命周期管理

注意事项

  • GHEC 与 GHES 是两套 API 表面,端点覆盖不完全一致。GHES 按版本(3.0~3.8 等)有功能差异,需要按目标实例的版本写代码并 X-GitHub-Api-Version 头锁定
  • EMU 账号有结构性限制:不能拥有 personal repository、不能 fork 到 enterprise 外、不能给其他 org 评论或 star。设计应用要预先考虑这些边界
  • 次要速率限制(content-creating 80/min、500/hour)和 OAuth token 申请 2,000/hour 容易触发,文档不显眼。开 retry 时按指数退避,不是固定间隔
04

官方快速开始

在官方文档查看快速开始:docs.github.com

05

快速开始

在 github.com/enterprise 起 GHEC 试用或在 enterprise.github.com 申请 GHES 报价。优先用 GitHub Apps 而不是 PAT:在 enterprise 设置里建 App,安装到目标 org,用 installation token 调 API,速率上限直接到 15,000/hour(GHEC)。REST 调用记得带 X-GitHub-Api-Version: 2026-03-10(或保留 2022-11-28 默认)。

06

常见问题

GHEC 和 GHES 的 API 一样吗?+

不完全一样。GHEC 用 api.github.com,端点覆盖最新,支持 audit log、EMU、SCIM 等 Cloud-only 功能;GHES 用你实例的域名({host}/api/v3 和 {host}/api/graphql),按 GHES 版本(3.0~3.8)有功能差异,部分端点滞后于 GHEC。代码要按目标实例版本写,并在 REST 调用时带 X-GitHub-Api-Version 头。

PAT 和 GitHub Apps,企业场景用哪个?+

GitHub Apps。三个原因:速率上限高(GHEC 15,000/hour 起,按 repo 与 user 线性扩展到 15,000 封顶;PAT 固定 5,000/hour),权限更细(fine-grained 安装级而不是用户级),无 user lifecycle 风险(PAT 随用户离职失效,App 不受影响)。仅对一次性脚本或个人工具用 PAT。

audit log API 在哪个 plan?+

只在 GHEC($21/seat/月首年)和 GHES。Free($0)和 Team($4/seat/月)没有 audit log API。GHEC 上端点 /enterprises/{enterprise}/audit-log 返回 SSO 登录、仓库权限变更、token 创建等事件,可对接 SIEM。

X-GitHub-Api-Version 头怎么用?+

按日期字符串指定版本,例如 X-GitHub-Api-Version: 2026-03-10。不带头时默认 2022-11-28。GitHub 承诺至少 24 个月支持窗口,版本退役前 response 会带 deprecation 头提示退役日期;过期后该版本返回 410 Gone,未指定版本的请求自动回退到次老活跃版本。

EMU 账号能用来做什么开发?+

EMU(Enterprise Managed Users)账号完全由你公司的 IdP 控制,只能访问 enterprise 内的资源。能:在 enterprise 内的 org 提交、review、收 issue、用 Actions、调 API。不能:拥有 personal repo、fork 到 enterprise 外、给其他 org 评论或 star、参与 enterprise 外的开源项目。集成应用如果依赖跨 org 操作,要避开 EMU 边界。

07

技术细节

CORS: ?HTTPS: Yes注册: Yes开源: No
认证方式
oauth
计费
paid
速率限制
Unauthenticated 60/hour per IP. PAT 5,000/hour. OAuth App 5,000/hour per app. GitHub Apps installation token: 5,000/hour minimum, 15,000/hour on Enterprise Cloud; scales +50/hour per repo and +50/hour per user beyond 20 of each, capped at 12,500/hour (or 15,000 on GHEC). GITHUB_TOKEN in Actions: 1,000/hour/repo (standard), 15,000/hour/repo (GHEC). Secondary limits: 100 concurrent requests, 900 points/min/endpoint, 90s CPU per 60s wall, 80 content-creating req/min (500/hour), 2,000 OAuth token requests/hour. GraphQL: 1 point read, 5 points mutation
免费额度
Enterprise features (audit log API, SAML SSO, EMU, advanced security) require GHEC ($21/user/mo first 12mo) or GHES (custom pricing). Free and Team tiers ($0 and $4/user/mo) do not unlock enterprise endpoints. github.com REST and GraphQL APIs themselves remain accessible on all tiers; the difference is the additional endpoints and the elevated rate limits
协议
REST, GraphQL
SDK
Octokit (JavaScript / TypeScript), Octokit (Ruby), Octokit (.NET), PyGithub (Python), go-github (Go), hub4j (Java)
08

标签