Meta - GitHub Docs

GitHub API Root

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

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://HOSTNAME/api/v3/

Response

Status: 200

Get GitHub AE meta information

Works with GitHub Apps

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.

HTTP response status codes

Status code	Descrição
`200`	OK
`304`	Not modified

Amostras de código

get/meta

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://HOSTNAME/api/v3/meta

Response

Status: 200

{
  "verifiable_password_authentication": true,
  "ssh_key_fingerprints": {
    "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
    "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ",
    "SHA256_ECDSA": "p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM",
    "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU"
  },
  "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"
  ]
}

Get Octocat

Works with GitHub Apps

Get the octocat as ASCII art

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parâmetros de consulta
Nome, Tipo, Descrição
`s`string The words to show in Octocat's speech bubble

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/octocat

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://HOSTNAME/api/v3/octocat

Response

Status: 200

Get the Zen of GitHub

Works with GitHub Apps

Get a random sentence from the Zen of GitHub

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/zen

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://HOSTNAME/api/v3/zen

Response

Status: 200