Skip to main content
A API REST agora é versionada. Para obter mais informações, confira "Sobre o controle de versão da API".

Pontos de extremidade da API REST para administração do GitHub Enterprise

Use a API REST para administrar sua empresa.

Observação

Esses pontos de extremidade só dão suporte à autenticação por meio de um personal access token (classic). Para saber mais, confira Gerenciar seus tokens de acesso pessoal.

URLs do ponto de extremidade

Esses pontos de extremidade, exceto a API de Gerenciamento do GitHub Enterprise Server, são prefixados com a seguinte URL:

http(s)://HOSTNAME/api/v3

Os endpoints da API de Gerenciamento do GitHub Enterprise Server são prefixados apenas com um nome de host e uma porta de administração.

http(s)://HOSTNAME:ADMINISTRATION-PORT/

Autenticação

Os endpoints da API da sua GitHub Enterprise Server instalação aceitam os mesmos métodos de autenticação que a API GitHub. Para saber mais, confira Autenticação na API REST.

Os tokens OAuth devem ter o site_adminescopo OAuth quando forem usados com esses endpoints.

Esses pontos de extremidade só são acessíveis para administradores de site autenticados GitHub Enterprise Server, exceto para os pontos de extremidade da API Endpoints da API REST para gerenciar o GitHub Enterprise Server, que permitem a autenticação como usuário do Console de Gerenciamento. Confira Administrar sua instância por meio da interface do usuário da Web.

Observação

Os endpoints da Console de Gerenciamento serão encerrando em uma futura versão do GitHub Enterprise Server. É possível obter acesso a uma funcionalidade semelhante ao usar Gerenciar pontos de extremidade do GitHub Enterprise Server. Para saber mais, confira Endpoints da API REST para gerenciar o GitHub Enterprise Server.

Informações da versão

A versão atual da sua empresa é retornada no cabeçalho de resposta da API REST: X-GitHub-Enterprise-Version: enterprise-server@3.18.0 Você também pode ler a versão atual chamando GET /meta. Para saber mais, confira Pontos de extremidade da API REST para metadados.

Pontos de extremidade