Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

GitHub Enterprise administration

You can use these endpoints to administer your enterprise.

Endpoint URLs

REST API endpoints—except Management Console API endpoints— are prefixed with the following URL:

http(s)://[hostname]/api/v3

Management Console API endpoints are only prefixed with a hostname:

http(s)://HOSTNAME/

Authentication

Your GitHub Enterprise Server installation's API endpoints accept the same authentication methods as the GitHub.com API. You can authenticate yourself with OAuth tokens (which can be created using the Authorizations API) or basic authentication. OAuth tokens must have the site_admin OAuth scope when used with Enterprise-specific endpoints.

Enterprise administration API endpoints are only accessible to authenticated GitHub Enterprise Server site administrators, except for the Management Console API, which requires the Management Console password.

Version information

The current version of your enterprise is returned in the response header of every API: X-GitHub-Enterprise-Version: enterprise-server@3.6.0 You can also read the current version by calling the meta endpoint.