Meta

Use a API REST para obter metainformações sobre o GitHub, incluindo os endereços IP dos serviços do GitHub.

GitHub API Root

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

Códigos de status de resposta HTTP para "GitHub API Root"

Código de status	Descrição
`200`	OK

Exemplos de código para "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" \
  https://api.github.com/

Response

Status: 200

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

Get GitHub meta information

Funciona com GitHub Apps

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "About GitHub's IP addresses."

The API's response also includes a list of GitHub's domain names.

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

Note: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

Códigos de status de resposta HTTP para "Get GitHub meta information"

Código de status	Descrição
`200`	OK
`304`	Not modified

Exemplos de código para "Get GitHub 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" \
  https://api.github.com/meta

Response

Status: 200

{
  "verifiable_password_authentication": true,
  "ssh_key_fingerprints": {
    "SHA256_RSA": 1234567890,
    "SHA256_DSA": 1234567890,
    "SHA256_ECDSA": 1234567890,
    "SHA256_ED25519": 1234567890
  },
  "ssh_keys": [
    "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  ],
  "hooks": [
    "192.0.2.1"
  ],
  "github_enterprise_importer": [
    "192.0.2.1"
  ],
  "web": [
    "192.0.2.1"
  ],
  "api": [
    "192.0.2.1"
  ],
  "git": [
    "192.0.2.1"
  ],
  "packages": [
    "192.0.2.1"
  ],
  "pages": [
    "192.0.2.1"
  ],
  "importer": [
    "192.0.2.1"
  ],
  "actions": [
    "192.0.2.1"
  ],
  "dependabot": [
    "192.0.2.1"
  ],
  "domains": {
    "website": [
      "*.example.com"
    ],
    "codespaces": [
      "*.example.com"
    ],
    "copilot": [
      "*.example.com"
    ],
    "packages": [
      "*.example.com"
    ]
  }
}

Get Octocat

Funciona com GitHub Apps

Get the octocat as ASCII art

Parâmetros para "Get Octocat"

Cabeçalhos
Nome, Type, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de consulta
Nome, Type, Descrição
`s` string The words to show in Octocat's speech bubble

Códigos de status de resposta HTTP para "Get Octocat"

Código de status	Descrição
`200`	OK

Exemplos de código para "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" \
  https://api.github.com/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 all API versions

Funciona com GitHub Apps

Get all supported GitHub API versions.

Códigos de status de resposta HTTP para "Get all API versions"

Código de status	Descrição
`200`	OK
`404`	Resource not found

Exemplos de código para "Get all API versions"

get/versions

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/versions

Response

Status: 200

[
  "2021-01-01",
  "2021-06-01",
  "2022-01-01"
]

Get the Zen of GitHub

Funciona com GitHub Apps

Get a random sentence from the Zen of GitHub

Códigos de status de resposta HTTP para "Get the Zen of GitHub"

Código de status	Descrição
`200`	OK

Exemplos de código para "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" \
  https://api.github.com/zen

Example response

Status: 200

"Responsive is better than fast"