This version of GitHub Enterprise Server was discontinued on 2024-09-25. 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 Server. For help with the upgrade, contact GitHub Enterprise support.

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.

Note

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 the Manage GitHub Enterprise Server API and Management Console API, are prefixed with the following URL:

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

Endpoints for the Manage GitHub Enterprise Server API and Management Console API are only prefixed with a hostname and administration port:

http(s)://HOSTNAME:ADMINISTRATION-PORT/

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 endpoints of the REST API endpoints for managing GitHub Enterprise Server API and REST API endpoints for Management Console API, which allow authentication as a Management Console user. See Administering your instance from the web UI.

Version information

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

Endpoints