メタデータ用 REST API エンドポイント

GitHub API Root

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

"GitHub API Root" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリックリソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"GitHub API Root" の HTTP 応答状態コード

状態コード	説明
`200`	OK

"GitHub API Root" のコードサンプル

要求の例

get/

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/

Response

Status: 200

{
  "current_user_url": "https://HOSTNAME/user",
  "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}",
  "authorizations_url": "https://HOSTNAME/authorizations",
  "code_search_url": "https://HOSTNAME/search/code?q={query}{&page,per_page,sort,order}",
  "commit_search_url": "https://HOSTNAME/search/commits?q={query}{&page,per_page,sort,order}",
  "emails_url": "https://HOSTNAME/user/emails",
  "emojis_url": "https://HOSTNAME/emojis",
  "events_url": "https://HOSTNAME/events",
  "feeds_url": "https://HOSTNAME/feeds",
  "followers_url": "https://HOSTNAME/user/followers",
  "following_url": "https://HOSTNAME/user/following{/target}",
  "gists_url": "https://HOSTNAME/gists{/gist_id}",
  "hub_url": "https://HOSTNAME/hub",
  "issue_search_url": "https://HOSTNAME/search/issues?q={query}{&page,per_page,sort,order}",
  "issues_url": "https://HOSTNAME/issues",
  "keys_url": "https://HOSTNAME/user/keys",
  "label_search_url": "https://HOSTNAME/search/labels?q={query}&repository_id={repository_id}{&page,per_page}",
  "notifications_url": "https://HOSTNAME/notifications",
  "organization_url": "https://HOSTNAME/orgs/{org}",
  "organization_repositories_url": "https://HOSTNAME/orgs/{org}/repos{?type,page,per_page,sort}",
  "organization_teams_url": "https://HOSTNAME/orgs/{org}/teams",
  "public_gists_url": "https://HOSTNAME/gists/public",
  "rate_limit_url": "https://HOSTNAME/rate_limit",
  "repository_url": "https://HOSTNAME/repos/{owner}/{repo}",
  "repository_search_url": "https://HOSTNAME/search/repositories?q={query}{&page,per_page,sort,order}",
  "current_user_repositories_url": "https://HOSTNAME/user/repos{?type,page,per_page,sort}",
  "starred_url": "https://HOSTNAME/user/starred{/owner}{/repo}",
  "starred_gists_url": "https://HOSTNAME/gists/starred",
  "topic_search_url": "https://HOSTNAME/search/topics?q={query}{&page,per_page}",
  "user_url": "https://HOSTNAME/users/{user}",
  "user_organizations_url": "https://HOSTNAME/user/orgs",
  "user_repositories_url": "https://HOSTNAME/users/{user}/repos{?type,page,per_page,sort}",
  "user_search_url": "https://HOSTNAME/search/users?q={query}{&page,per_page,sort,order}"
}

Get GitHub Enterprise Server meta information

"Get GitHub Enterprise Server meta information" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリックリソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Get GitHub Enterprise Server meta information" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`304`	Not modified

"Get GitHub Enterprise Server meta information" のコードサンプル

要求の例

get/meta

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/meta

Response

Status: 200

{
  "verifiable_password_authentication": true,
  "packages": [
    "192.0.2.1"
  ],
  "domains": {
    "website": [
      "*.example.com"
    ],
    "codespaces": [
      "*.example.com"
    ],
    "copilot": [
      "*.example.com"
    ],
    "packages": [
      "*.example.com"
    ]
  },
  "installed_version": "3.11.0"
}

Get Octocat

Get the octocat as ASCII art

"Get Octocat" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリックリソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Get Octocat" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

クエリパラメーター
名前, Type, 説明
`s` string The words to show in Octocat's speech bubble

"Get Octocat" の HTTP 応答状態コード

状態コード	説明
`200`	OK

"Get Octocat" のコードサンプル

要求の例

get/octocat

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/octocat

Response

Status: 200

"               MMM.           .MMM\n               MMMMMMMMMMMMMMMMMMM\n               MMMMMMMMMMMMMMMMMMM      ___________________________________\n              MMMMMMMMMMMMMMMMMMMMM    |                                   |\n             MMMMMMMMMMMMMMMMMMMMMMM   | Avoid administrative distraction. |\n            MMMMMMMMMMMMMMMMMMMMMMMM   |_   _______________________________|\n            MMMM::- -:::::::- -::MMMM    |/\n             MM~:~ 00~:::::~ 00~:~MM\n        .. MMMMM::.00:::+:::.00::MMMMM ..\n              .MM::::: ._. :::::MM.\n                 MMMM;:::::;MMMM\n          -MM        MMMMMMM\n          ^  M+     MMMMMMMMM\n              MMMMMMM MM MM MM\n                   MM MM MM MM\n                   MM MM MM MM\n                .~~MM~MM~MM~MM~~.\n             ~~~~MM:~MM~~~MM~:MM~~~~\n            ~~~~~~==~==~~~==~==~~~~~~\n             ~~~~~~==~==~==~==~~~~~~\n                 :~==~==~==~==~~\n"

Get the Zen of GitHub

Get a random sentence from the Zen of GitHub

"Get the Zen of GitHub" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリックリソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Get the Zen of GitHub" の HTTP 応答状態コード

状態コード	説明
`200`	OK

"Get the Zen of GitHub" のコードサンプル

要求の例

get/zen

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/zen

Example response

Status: 200

"Responsive is better than fast"