メタ情報

GitHub API Root

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

get /

コードサンプル

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


Get GitHub Enterprise Server meta information

get /meta

コードサンプル

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": "3.0.0"
}

Not modified

Status: 304 Not Modified

Notes


Get Octocat

Get the octocat as ASCII art

get /octocat

パラメータ

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

コードサンプル

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


Get the Zen of GitHub

Get a random sentence from the Zen of GitHub

get /zen

コードサンプル

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


このドキュメントは役立ちましたか?プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?

GitHubコミュニティで質問するサポートへの連絡