ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2021-03-02. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

メタ情報

ここには以下の内容があります:

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

Default response

Status: 200 OK
{
  "verifiable_password_authentication": true,
  "installed_version": "2.20.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