GitHub API Root
Get Hypermedia links to resources accessible in GitHub's REST API
get /
コードサンプル
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/
JavaScript (@octokit/core.js)
await octokit.request('GET /')
Response
Status: 200 OK
Notes
Get GitHub Enterprise Server meta information
This endpoint provides a list of GitHub's IP addresses. For more information, see "About GitHub's IP addresses."
get /meta
コードサンプル
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/meta
JavaScript (@octokit/core.js)
await octokit.request('GET /meta')
Default response
Status: 200 OK
{
"verifiable_password_authentication": true,
"installed_version": "2.19.0",
"github_services_sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
}
Not modified
Status: 304 Not Modified
Notes
Get Octocat
Get the octocat as ASCII art
get /octocat
パラメータ
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
s |
string | query | The words to show in Octocat's speech bubble |
コードサンプル
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/octocat
JavaScript (@octokit/core.js)
await octokit.request('GET /octocat')
Response
Status: 200 OK
Notes
Get the Zen of GitHub
Get a random sentence from the Zen of GitHub
get /zen
コードサンプル
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/zen
JavaScript (@octokit/core.js)
await octokit.request('GET /zen')
Response
Status: 200 OK