Meta

In this article

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.

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" \
  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

Code samples

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.21.0"
}

Not modified

Status: 304 Not Modified

Notes


Get Octocat

Get the octocat as ASCII art

get /octocat

Parameters

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended.

s string query

The words to show in Octocat's speech bubble

Code samples

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

Code samples

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

Notes


Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.