Note
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 pela API Gerenciar o GitHub Enterprise Server e pela API do Console de Gerenciamento,, são prefixados com a seguinte URL:
http(s)://HOSTNAME/api/v3
Os pontos de extremidade da API Gerenciar o GitHub Enterprise Server e a API do Console de Gerenciamento são prefixados apenas com um nome de host e uma porta de administração:
http(s)://HOSTNAME:ADMINISTRATION-PORT/
Autenticação
Os pontos de extremidade da API de instalação do GitHub Enterprise Server aceitam os mesmos métodos de autenticação da API do GitHub. Para saber mais, confira Autenticação na API REST.
Os tokens OAuth devem ter o escopo do OAuth site_admin
quando forem usados com esses pontos de extremidade.
Eles são acessíveis somente para administradores de sites autenticados do GitHub Enterprise Server, exceto no caso dos pontos de extremidade das APIs do Pontos de extremidade da API REST para gerenciar o GitHub Enterprise Server e do Pontos de extremidade da API REST para o console de gerenciamento , que permitem autenticação como usuário do console de gerenciamento. Confira Administrar sua instância por meio da interface do usuário da Web.
Note
Os pontos de extremidade do Console de Gerenciamento serão preteridos em uma versão futura 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 Pontos de extremidade 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.14.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.