GitHub API Root
Get Hypermedia links to resources accessible in GitHub's REST API
get /Code samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
http(s)://{hostname}/api/v3/JavaScript (@octokit/core.js)
await octokit.request('GET /')
Response
Status: 200 OKNotes
get /metaCode samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
http(s)://{hostname}/api/v3/metaJavaScript (@octokit/core.js)
await octokit.request('GET /meta')
Default response
Status: 200 OK{
"verifiable_password_authentication": true,
"installed_version": "2.20.0"
}
Not modified
Status: 304 Not ModifiedNotes
Get Octocat
Get the octocat as ASCII art
get /octocatParameters
| Name | Type | In | Description |
|---|---|---|---|
accept |
string | header |
Setting to |
s |
string | query | The words to show in Octocat's speech bubble |
Code samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
http(s)://{hostname}/api/v3/octocatJavaScript (@octokit/core.js)
await octokit.request('GET /octocat')
Response
Status: 200 OKNotes
Get the Zen of GitHub
Get a random sentence from the Zen of GitHub
get /zenCode samples
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
http(s)://{hostname}/api/v3/zenJavaScript (@octokit/core.js)
await octokit.request('GET /zen')
Response
Status: 200 OK