此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-03-26. 即使针对重大安全问题，也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能，请升级到最新版本的 GitHub Enterprise。 如需升级帮助，请联系 GitHub Enterprise 支持。
站点管理员将企业服务器实例升级为 Enterprise Server 3.9 或更高版本后，REST API 将进行版本控制。 若要了解如何查找实例的版本，请参阅“关于 GitHub Docs 的版本”。 有关详细信息，请参阅“关于 API 版本控制”。
元数据的 REST API 终结点
使用 REST API 返回关于 GitHub Enterprise Server 的元信息，包括 GitHub Enterprise Server 服务的 IP 地址。
GitHub API Root
Get Hypermedia links to resources accessible in GitHub's REST API
“GitHub API Root”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“GitHub API Root”的示例代码
请求示例
get/
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/Response
Status: 200{
"current_user_url": "https://HOSTNAME/user",
"current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}",
"authorizations_url": "https://HOSTNAME/authorizations",
"code_search_url": "https://HOSTNAME/search/code?q={query}{&page,per_page,sort,order}",
"commit_search_url": "https://HOSTNAME/search/commits?q={query}{&page,per_page,sort,order}",
"emails_url": "https://HOSTNAME/user/emails",
"emojis_url": "https://HOSTNAME/emojis",
"events_url": "https://HOSTNAME/events",
"feeds_url": "https://HOSTNAME/feeds",
"followers_url": "https://HOSTNAME/user/followers",
"following_url": "https://HOSTNAME/user/following{/target}",
"gists_url": "https://HOSTNAME/gists{/gist_id}",
"hub_url": "https://HOSTNAME/hub",
"issue_search_url": "https://HOSTNAME/search/issues?q={query}{&page,per_page,sort,order}",
"issues_url": "https://HOSTNAME/issues",
"keys_url": "https://HOSTNAME/user/keys",
"label_search_url": "https://HOSTNAME/search/labels?q={query}&repository_id={repository_id}{&page,per_page}",
"notifications_url": "https://HOSTNAME/notifications",
"organization_url": "https://HOSTNAME/orgs/{org}",
"organization_repositories_url": "https://HOSTNAME/orgs/{org}/repos{?type,page,per_page,sort}",
"organization_teams_url": "https://HOSTNAME/orgs/{org}/teams",
"public_gists_url": "https://HOSTNAME/gists/public",
"rate_limit_url": "https://HOSTNAME/rate_limit",
"repository_url": "https://HOSTNAME/repos/{owner}/{repo}",
"repository_search_url": "https://HOSTNAME/search/repositories?q={query}{&page,per_page,sort,order}",
"current_user_repositories_url": "https://HOSTNAME/user/repos{?type,page,per_page,sort}",
"starred_url": "https://HOSTNAME/user/starred{/owner}{/repo}",
"starred_gists_url": "https://HOSTNAME/gists/starred",
"topic_search_url": "https://HOSTNAME/search/topics?q={query}{&page,per_page}",
"user_url": "https://HOSTNAME/users/{user}",
"user_organizations_url": "https://HOSTNAME/user/orgs",
"user_repositories_url": "https://HOSTNAME/users/{user}/repos{?type,page,per_page,sort}",
"user_search_url": "https://HOSTNAME/search/users?q={query}{&page,per_page,sort,order}"
}Get GitHub Enterprise Server meta information
“Get GitHub Enterprise Server meta information”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
304 | Not modified |
“Get GitHub Enterprise Server meta information”的示例代码
请求示例
get/meta
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/metaResponse
Status: 200{
"verifiable_password_authentication": true,
"packages": [
"192.0.2.1"
],
"dependabot": [
"192.0.2.1"
],
"domains": {
"website": [
"*.example.com"
],
"codespaces": [
"*.example.com"
],
"copilot": [
"*.example.com"
],
"packages": [
"*.example.com"
]
},
"installed_version": "3.8.0"
}Get Octocat
Get the octocat as ASCII art
“Get Octocat”的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
s string The words to show in Octocat's speech bubble |
“Get Octocat”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“Get Octocat”的示例代码
请求示例
get/octocat
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/octocatResponse
Status: 200" MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n"Get the Zen of GitHub
“Get the Zen of GitHub”的示例代码
请求示例
get/zen
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/zenExample response
Status: 200"Responsive is better than fast"