Skip to main content

Enterprise Server 3.15 目前作为候选发布提供。

REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

适用于 GitHub Enterprise 管理的 REST API 终结点

使用 REST API 管理企业。

这些终结点仅支持使用 personal access token (classic) 进行身份验证。 有关详细信息,请参阅“管理个人访问令牌”。

端点 URL

这些终结点(管理控制台终结点除外)是以下 URL 的前缀:

http(s)://HOSTNAME/api/v3

管理控制台终结点仅以主机名为前缀:

http(s)://HOSTNAME/

身份验证

GitHub Enterprise Server 安装的 API 终结点接受与 GitHub API 相同的身份验证方法。 有关详细信息,请参阅“对 REST API 进行身份验证”。

与这些端点一起使用时,OAuth 令牌必须具有 site_admin OAuth 范围

这些端点只有经过身份验证的 GitHub Enterprise Server 站点管理员可以访问,但管理控制台端点例外,它需要管理控制台密码

**注意:**管理控制台 端点将在 GitHub Enterprise Server 的未来版本中弃用。 你可以使用“管理 GitHub Enterprise Server 端点”访问相同的功能。 有关详细信息,请参阅“适用于管理 GitHub Enterprise Server 的 REST API 终结点”。

版本信息

企业当前版本在 REST API 响应头中返回:X-GitHub-Enterprise-Version: enterprise-server@3.15.0 还可通过调用 GET /meta 来读取当前版本。 有关详细信息,请参阅“元数据的 REST API 终结点”。

终结点