Skip to main content
All products
REST API

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

Use the REST API to administer your enterprise.

Endpoint URLs

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

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

Management Console 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 API. For more information, see "Authenticating to the REST API."

OAuth tokens must have the site_admin OAuth scope when used with Enterprise-specific endpoints.

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

Version information

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

Endpoints