Meta

GitHub API Root

Get Hypermedia links to resources accessible in GitHub's REST API

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

• Works with GitHub Apps

Get GitHub meta information

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "About GitHub's IP addresses."

Note: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.

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')

Response

Status: 200 OK

{
  "verifiable_password_authentication": true,
  "ssh_key_fingerprints": {
    "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
    "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ"
  },
  "hooks": [
    "192.30.252.0/22"
  ],
  "web": [
    "192.30.252.0/22",
    "185.199.108.0/22"
  ],
  "api": [
    "192.30.252.0/22",
    "185.199.108.0/22"
  ],
  "git": [
    "192.30.252.0/22"
  ],
  "packages": [
    "192.30.252.0/22"
  ],
  "pages": [
    "192.30.252.153/32",
    "192.30.252.154/32"
  ],
  "importer": [
    "54.158.161.132",
    "54.226.70.38"
  ],
  "actions": [
    "13.64.0.0/16",
    "13.65.0.0/16"
  ],
  "dependabot": [
    "54.158.161.132"
  ]
}

Not modified

Status: 304 Not Modified

Notes

• Works with GitHub Apps

Get Octocat

Get the octocat as ASCII art

Parameters

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

• Works with GitHub Apps

Get the Zen of GitHub

Get a random sentence from the Zen of GitHub

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

• Works with GitHub Apps