# GitHub Enterprise Server (on-prem) — Issue Tracking API: overview

> Canonical URL: https://developers.apideck.com/apis/issue-tracking/github-server/overview

GitHub Enterprise Server is the self-hosted version of GitHub for organizations that want to run GitHub on their own infrastructure.
- Status: live
- Authentication: apiKey

- **account type required:** A GitHub Enterprise Server instance, with a user account on it.
- **sandbox available:** true
- **sandbox url:** https://enterprise.github.com/trial
- **environment notes:**   - **description:** Each connection has one endpoint: the consumer's own instance. GitHub has no separate shared test or production host, so testing and production use the same kind of token.
  - **environment:** Single environment
  - **environment:** Testing
  - **description:** A connection to a live instance reads and writes real repository data, so test against an instance you do not use in production.
- **difficulty reason:** Personal Access Token - Each Consumer Creates Their Own on a Self-Hosted Instance
- **partnership required:** false
- **supported resource categories:**   - **resources:** organizations
collections
  - **name:** Organisation Structure
  - **resources:** collection-tickets
collection-ticket-comments
collection-tags
  - **name:** Tickets
  - **resources:** collection-users
  - **name:** People
- **external guides:**   - **title:** Managing your personal access tokens (GitHub Enterprise Server)
  - **source:** GitHub
  - **url:** https://docs.github.com/en/enterprise-server@3.22/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
  - **url:** https://docs.github.com/en/enterprise-server@3.20/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise
  - **source:** GitHub
  - **title:** Enforcing policies for personal access tokens in your enterprise
  - **title:** Configuring rate limits
  - **url:** https://docs.github.com/en/enterprise-server@3.21/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits
  - **source:** GitHub
- **important to know:** The connection stops on the day the personal access token expires, and Apideck cannot renew it: the consumer has to create a new token and paste it in again. The consumer picks the expiry, and an enterprise maximum-lifetime policy can force a short one.
An enterprise owner can bar personal access tokens from organisations the enterprise owns. This connector works only with a classic token, so on an instance with that policy switched on the consumer cannot connect until the owner lifts it.
Apideck calls the instance over the public internet and requires a valid TLS certificate, so an instance reachable only on a private network or behind a firewall that blocks Apideck cannot connect.
- **apideck credentials available:** false
- **webhooks:** Virtual webhooks - ticket created and updated events
- **authentication note:** Personal access token (classic), sent as a bearer token; not OAuth.
- **responsibility matrix:**   - **customer:** ✓ Via Apideck Dashboard
  - **area:** Enable the GitHub Enterprise Server Connector
  - **area:** Create a Classic Personal Access Token on the Instance
  - **consumer:** ✓
  - **area:** Supply the Host, Token & Organisation in Vault
  - **consumer:** ✓
  - **area:** Renew the Token Before It Expires
  - **consumer:** ✓
  - **apideck:** ✓
  - **area:** Store & Encrypt Credentials
  - **area:** Route Requests to the Consumer's Instance
  - **apideck:** ✓
  - **area:** Build via the Unified API
  - **apideck:** ✓ Maintains connector
  - **customer:** ✓ Builds the requests
  - **customer:** ✓ Via Apideck Dashboard
  - **apideck:** ✓ Logs & alerts
  - **area:** Monitor Connections
  - **consumer:** ✓ Can revoke the token anytime
- **costs:** No separate charge for API access; the REST API comes with the consumer's own GitHub Enterprise Server licence.
- **rate limits:** Disabled by default on GitHub Enterprise Server; the instance's site administrator can enable limits and set them.
- **sandbox note:** Free 45-day trial, installed as a virtual appliance you deploy on-premises or in the cloud.
- **apideck credentials note:** Each consumer supplies their own instance host and token.
- **difficulty:** moderate
- **consumer access level:** Any organisation member, no owner rights needed; the connection reaches what that member can access.

## Supported resources

- **id:** collections
- **custom field support:** false
- **name:** Collections
- **downstream id:** repos
- **downstream name:** Repos
- **status:** live
- **name:** Tickets
- **custom field support:** false
- **downstream id:** repo-issues
- **downstream name:** Repo Issues
- **id:** collection-tickets
- **status:** live
- **name:** Users
- **downstream name:** Repo Users
- **status:** live
- **custom field support:** false
- **id:** collection-users
- **downstream id:** repo-users
- **downstream id:** repo-issue-comments
- **downstream name:** Repo Issue Comments
- **status:** live
- **custom field support:** false
- **name:** Comments
- **id:** collection-ticket-comments
- **id:** collection-tags
- **name:** Tags
- **status:** live
- **downstream id:** repo-labels
- **custom field support:** false
- **downstream name:** Repo Labels

An omitted operation list does not establish operation support. Verify the selected operation in the coverage matrix.

[API reference](https://developers.apideck.com/apis/issue-tracking/reference.md) · [Coverage matrix](https://developers.apideck.com/apis/issue-tracking/coverage)