Meta

Download Spec

Endpoints that give information about the API.

GitHub API Root

get /

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

Response

Examples Schema

Response

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

current_user_url

string

uri-template

required

current_user_authorizations_html_url

string

uri-template

required

authorizations_url

string

uri-template

required

code_search_url

string

uri-template

required

commit_search_url

string

uri-template

required

emails_url

string

uri-template

required

emojis_url

string

uri-template

required

events_url

string

uri-template

required

feeds_url

string

uri-template

required

followers_url

string

uri-template

required

following_url

string

uri-template

required

gists_url

string

uri-template

required

hub_url

string

uri-template

required

issue_search_url

string

uri-template

required

issues_url

string

uri-template

required

keys_url

string

uri-template

required

label_search_url

string

uri-template

required

notifications_url

string

uri-template

required

organization_url

string

uri-template

required

organization_repositories_url

string

uri-template

required

organization_teams_url

string

uri-template

required

public_gists_url

string

uri-template

required

rate_limit_url

string

uri-template

required

repository_url

string

uri-template

required

repository_search_url

string

uri-template

required

current_user_repositories_url

string

uri-template

required

starred_url

string

uri-template

required

starred_gists_url

string

uri-template

required

topic_search_url

string

uri-template

user_url

string

uri-template

required

user_organizations_url

string

uri-template

required

user_repositories_url

string

uri-template

required

user_search_url

string

uri-template

required

Get GitHub Enterprise Server meta information

get /meta

Response

Examples Schema

Response

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

Not modified

Empty response

verifiable_password_authentication

boolean

required

Example
true

packages

array[string]

Example
[ "192.0.2.1" ]

string

dependabot

array[string]

Example
[ "192.0.2.1" ]

string

installed_version

string

Example
"3.9.0"

No schema

Get Octocat

get /octocat

Get the octocat as ASCII art

s

string

The words to show in Octocat's speech bubble

Response

Examples Schema

Response

"               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"

string

Get the Zen of GitHub

get /zen

Get a random sentence from the Zen of GitHub

Response

Examples Schema

Response

"Responsive is better than fast"

string

Was this page helpful?