Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

This version of GitHub Enterprise was discontinued on 2023-03-15. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

After a site administrator upgrades your Enterprise Server instance to Enterprise Server 3.9 or later, the REST API will be versioned. To learn how to find your instance's version, see "About versions of GitHub Docs". For more information, see "About API versioning."

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.4.0 You can also read the current version by calling the meta endpoint.

Endpoints