メタ情報

GitHub API Root

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

コードサンプル

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 OK

Notes

• Works with GitHub Apps

Get GitHub Enterprise Server meta information

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/meta

JavaScript (@octokit/core.js)

await octokit.request('GET /meta')

Response

Status: 200 OK

{
  "verifiable_password_authentication": true,
  "packages": [
    "192.30.252.0/22"
  ],
  "dependabot": [
    "54.158.161.132"
  ],
  "installed_version": "2.21.0"
}

Not modified

Status: 304 Not Modified

Notes

• Works with GitHub Apps

Get Octocat

Get the octocat as ASCII art

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/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

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/zen

JavaScript (@octokit/core.js)

await octokit.request('GET /zen')

Response

Status: 200 OK

Notes

• Works with GitHub Apps