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

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

使用 REST API 管理企业。

Note

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

端点 URL

这些终结点(Manage GitHub Enterprise Server API 和管理控制台 API 除外)均以以下 URL 为前缀:

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

Manage GitHub Enterprise Server API 和管理控制台 API 的终结点均以以下主机名和管理端口为前缀:

http(s)://HOSTNAME:ADMINISTRATION-PORT/

身份验证

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

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

这些终结点仅供经过身份验证的 GitHub Enterprise Server 站点管理员访问,但 适用于管理 GitHub Enterprise Server 的 REST API 终结点 API 和 适用于管理控制台的 REST API 终结点 API 的终结点除外,这些终结点允许以管理控制台用户的身份进行身份验证。 请参阅 从 Web UI 管理实例

Note

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

版本信息

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

终结点