This version of GitHub Enterprise was discontinued on 2023-07-06. 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.
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/v3Management 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.5.0
You can also read the current version by calling the meta endpoint.
Endpoints
- Admin stats
- Get all statistics
- Get comment statistics
- Get gist statistics
- Get hooks statistics
- Get issue statistics
- Get milestone statistics
- Get organization statistics
- Get pages statistics
- Get pull request statistics
- Get repository statistics
- Get users statistics
- Announcement
- Get the global announcement banner
- Set the global announcement banner
- Remove the global announcement banner
- Audit log
- Billing
- Global Webhooks
- List global webhooks
- Create a global webhook
- Get a global webhook
- Update a global webhook
- Delete a global webhook
- Ping a global webhook
- LDAP
- Update LDAP mapping for a team
- Sync LDAP mapping for a team
- Update LDAP mapping for a user
- Sync LDAP mapping for a user
- License
- Management Console
- Get the configuration status
- Start a configuration process
- Get the maintenance status
- Enable or disable maintenance mode
- Get settings
- Set settings
- Get all authorized SSH keys
- Add an authorized SSH key
- Remove an authorized SSH key
- Create a GitHub license
- Upgrade a license
- Organization Pre-receive Hooks
- List pre-receive hooks for an organization
- Get a pre-receive hook for an organization
- Update pre-receive hook enforcement for an organization
- Remove pre-receive hook enforcement for an organization
- Organizations
- Pre-receive Environments
- List pre-receive environments
- Create a pre-receive environment
- Get a pre-receive environment
- Update a pre-receive environment
- Delete a pre-receive environment
- Start a pre-receive environment download
- Get the download status for a pre-receive environment
- Pre-receive Hooks
- List pre-receive hooks
- Create a pre-receive hook
- Get a pre-receive hook
- Update a pre-receive hook
- Delete a pre-receive hook
- Repository Pre-receive Hooks
- List pre-receive hooks for a repository
- Get a pre-receive hook for a repository
- Update pre-receive hook enforcement for a repository
- Remove pre-receive hook enforcement for a repository
- Users
- List public keys
- Delete a public key
- List personal access tokens
- Delete a personal access token
- Create a user
- Update the username for a user
- Delete a user
- Create an impersonation OAuth token
- Delete an impersonation OAuth token
- Promote a user to be a site administrator
- Demote a site administrator
- Suspend a user
- Unsuspend a user