GitHub Enterprise Server (on-prem)
Service ID: github-server
GitHub Enterprise Server is the self-hosted version of GitHub for organizations that want to run GitHub on their own infrastructure.
At a Glance
- Difficulty
- ⚡MODERATEPersonal Access Token - Each Consumer Creates Their Own on a Self-Hosted Instance
- Authentication
- API KeyPersonal access token (classic), sent as a bearer token; not OAuth.
- Webhooks
- Virtual webhooks↗ - ticket created and updated events
- Partnership Required
- No
- Apideck Credentials
- Not available(Each consumer supplies their own instance host and token.)
- Costs
- No separate charge for API access; the REST API comes with the consumer's own GitHub Enterprise Server licence.
- Sandbox Availability
- Available — Access Sandbox↗(Free 45-day trial, installed as a virtual appliance you deploy on-premises or in the cloud.)
- Account Type Required
- A GitHub Enterprise Server instance, with a user account on it.
- Consumer Access Level
- Any organisation member, no owner rights needed; the connection reaches what that member can access.
- Rate Limits
- Disabled by default on GitHub Enterprise Server; the instance's site administrator can enable limits and set them.
Responsibility matrix
| Task | You (Customer) | Your Consumer | Apideck |
|---|---|---|---|
| Enable the GitHub Enterprise Server Connector | ✓ Via Apideck Dashboard | — | — |
| Create a Classic Personal Access Token on the Instance | — | ✓ | — |
| Supply the Host, Token & Organisation in Vault | — | ✓ | — |
| Renew the Token Before It Expires | — | ✓ | — |
| Store & Encrypt Credentials | — | — | ✓ |
| Route Requests to the Consumer's Instance | — | — | ✓ |
| Build via the Unified API | ✓ Builds the requests | — | ✓ Maintains connector |
| Monitor Connections | ✓ Via Apideck Dashboard | ✓ Can revoke the token anytime | ✓ Logs & alerts |
Environments
- Single environment
- 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.
- Testing
- A connection to a live instance reads and writes real repository data, so test against an instance you do not use in production.
🚨Important to Know About GitHub Enterprise Server (on-prem)
- 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.
⚠️
2 gotchas across 1 resource
Connector-specific behaviors and limitations to be aware of
📦
5 supported resources
View field mappings, supported operations, and schema details