Meta

Utilisez l’API REST pour obtenir les métadonnées sur GitHub Enterprise Server, notamment les adresses IP des services GitHub Enterprise Server.

GitHub API Root

Compatible avec GitHub Apps

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

Codes d’état de la réponse HTTP pour « GitHub API Root »

Code d’état	Description
`200`	OK

Exemples de code pour « GitHub API Root »

get/

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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

Compatible avec GitHub Apps

Codes d’état de la réponse HTTP pour « Get GitHub Enterprise Server meta information »

Code d’état	Description
`200`	OK
`304`	Not modified

Exemples de code pour « Get GitHub Enterprise Server meta information »

get/meta

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

Response

Status: 200

{
  "verifiable_password_authentication": true,
  "packages": [
    "192.0.2.1"
  ],
  "dependabot": [
    "192.0.2.1"
  ],
  "installed_version": "3.7.0"
}

Get Octocat

Compatible avec GitHub Apps

Get the octocat as ASCII art

Paramètres pour « Get Octocat »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
Paramètres de requête
Nom, Type, Description
`s` string The words to show in Octocat's speech bubble

Codes d’état de la réponse HTTP pour « Get Octocat »

Code d’état	Description
`200`	OK

Exemples de code pour « Get Octocat »

get/octocat

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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

Compatible avec GitHub Apps

Get a random sentence from the Zen of GitHub

Codes d’état de la réponse HTTP pour « Get the Zen of GitHub »

Code d’état	Description
`200`	OK

Exemples de code pour « Get the Zen of GitHub »

get/zen

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

Example response

Status: 200

"Responsive is better than fast"