REST API 现在已进行版本控制。 更多信息，请参见“关于 API 版本控制”。
用于元数据的 REST API 端点
使用 REST API 获取有关 GitHub 的元信息，包括 GitHub 服务的 IP 地址。
GitHub API 根目录
获取 GitHub REST API 中可访问资源的超媒体链接
“GitHub API 根目录”的细粒度访问令牌
此端点支持以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源，则无需身份验证即可使用此端点。
“GitHub API 根目录”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
“GitHub API 根目录”的代码示例
请求示例
get/
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/响应
状态：200{ "current_user_url": "https://api.github.com/user", "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", "authorizations_url": "https://api.github.com/authorizations", "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", "emails_url": "https://api.github.com/user/emails", "emojis_url": "https://api.github.com/emojis", "events_url": "https://api.github.com/events", "feeds_url": "https://api.github.com/feeds", "followers_url": "https://api.github.com/user/followers", "following_url": "https://api.github.com/user/following{/target}", "gists_url": "https://api.github.com/gists{/gist_id}", "hub_url": "https://api.github.com/hub", "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", "issues_url": "https://api.github.com/issues", "keys_url": "https://api.github.com/user/keys", "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", "notifications_url": "https://api.github.com/notifications", "organization_url": "https://api.github.com/orgs/{org}", "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", "organization_teams_url": "https://api.github.com/orgs/{org}/teams", "public_gists_url": "https://api.github.com/gists/public", "rate_limit_url": "https://api.github.com/rate_limit", "repository_url": "https://api.github.com/repos/{owner}/{repo}", "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", "starred_gists_url": "https://api.github.com/gists/starred", "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", "user_url": "https://api.github.com/users/{user}", "user_organizations_url": "https://api.github.com/user/orgs", "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" }获取 GitHub 元信息
返回有关 GitHub 的元信息，包括 GitHub IP 地址列表。更多信息，请参见“关于 GitHub 的 IP 地址”。
API 的响应还包括 GitHub 的域名列表。
文档响应中显示的值是示例值。您必须始终直接查询 API 以获取最新值。
注意
此端点返回 IPv4 和 IPv6 地址。但是，并非所有功能都支持 IPv6。您应参考每个功能的具体文档以确定是否支持 IPv6。
“获取 GitHub 元信息”的细粒度访问令牌
此端点支持以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源，则无需身份验证即可使用此端点。
“获取 GitHub 元信息”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
304 | 未修改 |
“获取 GitHub 元信息”的代码示例
请求示例
get/meta
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/meta响应
状态：200{ "verifiable_password_authentication": true, "ssh_key_fingerprints": { "SHA256_RSA": 1234567890, "SHA256_DSA": 1234567890, "SHA256_ECDSA": 1234567890, "SHA256_ED25519": 1234567890 }, "ssh_keys": [ "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ" ], "hooks": [ "192.0.2.1" ], "github_enterprise_importer": [ "192.0.2.1" ], "web": [ "192.0.2.1" ], "api": [ "192.0.2.1" ], "git": [ "192.0.2.1" ], "packages": [ "192.0.2.1" ], "pages": [ "192.0.2.1" ], "importer": [ "192.0.2.1" ], "actions": [ "192.0.2.1" ], "actions_macos": [ "192.0.2.1" ], "dependabot": [ "192.0.2.1" ], "copilot": [ "192.0.2.1" ], "domains": { "website": [ "*.example.com" ], "codespaces": [ "*.example.com" ], "copilot": [ "*.example.com" ], "packages": [ "*.example.com" ] } }获取 Octocat
以 ASCII 艺术形式获取 Octocat
“获取 Octocat”的细粒度访问令牌
此端点支持以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源，则无需身份验证即可使用此端点。
“获取 Octocat”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
s 字符串要在 Octocat 的气泡中显示的文字 |
“获取 Octocat”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
“获取 Octocat”的代码示例
请求示例
get/octocat
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/octocat响应
状态：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"获取所有 API 版本
获取所有受支持的 GitHub API 版本。
“获取所有 API 版本”的细粒度访问令牌
此端点支持以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源，则无需身份验证即可使用此端点。
“获取所有 API 版本”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
404 | 资源未找到 |
“获取所有 API 版本”的代码示例
请求示例
get/versions
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/versions响应
状态：200[
"2021-01-01",
"2021-06-01",
"2022-01-01"
]获取 GitHub 的禅语
获取 GitHub 禅语中的随机句子
“获取 GitHub 的禅语”的细粒度访问令牌
此端点支持以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源，则无需身份验证即可使用此端点。
“获取 GitHub 的禅语”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
“获取 GitHub 的禅语”的代码示例
请求示例
get/zen
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/zen示例响应
状态：200"响应式比快速更好"