Enterprise Server 3.15 is currently available as a release candidate.

The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for GitHub Enterprise administration

Use the REST API to administer your enterprise.

These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."

Endpoint URLs

These endpoints —except Manage GitHub Enterprise Server API—are prefixed with the following URL:

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

Manage GitHub Enterprise Server 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 API. For more information, see "Authenticating to the REST API."

OAuth tokens must have the site_admin OAuth scope when used with these endpoints.

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

Note

The Management Console endpoints will be deprecated in a future version of GitHub Enterprise Server. You can access the same functionality using the Manage GitHub Enterprise Server endpoints. For more information, see "REST API endpoints for managing GitHub Enterprise Server."

Version information

The current version of your enterprise is returned in the REST API response header: X-GitHub-Enterprise-Version: enterprise-server@3.15.0 You can also read the current version by calling GET /meta. For more information, see "REST API endpoints for meta data."

Endpoints