REST-API-Endpunkte für Metadaten

GitHub API Root

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

Feinkörnige Zugriffstoken für "GitHub API Root"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das feinkörnige Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

HTTP-Antwortstatuscodes für "GitHub API Root"

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für "GitHub API Root"

Anforderungsbeispiel

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

Feinkörnige Zugriffstoken für "Get GitHub Enterprise Server meta information"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das feinkörnige Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

HTTP-Antwortstatuscodes für "Get GitHub Enterprise Server meta information"

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für "Get GitHub Enterprise Server meta information"

Anforderungsbeispiel

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.18.0"
}

Get Octocat

Get the octocat as ASCII art

Feinkörnige Zugriffstoken für "Get Octocat"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das feinkörnige Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für "Get Octocat"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Abfrageparameter
Name, Typ, BESCHREIBUNG
`s` string The words to show in Octocat's speech bubble

HTTP-Antwortstatuscodes für "Get Octocat"

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für "Get Octocat"

Anforderungsbeispiel

get/octocat

curl -L \
  -H "Accept: application/octocat-stream" \
  -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

Feinkörnige Zugriffstoken für "Get the Zen of GitHub"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das feinkörnige Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

HTTP-Antwortstatuscodes für "Get the Zen of GitHub"

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für "Get the Zen of GitHub"

Anforderungsbeispiel

get/zen

curl -L \
  -H "Accept: text/plain" \
  -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"