GitHub Endpoint
GitHub endpoints connect Eve to GitHub repositories, issues, pull requests, and automation surfaces through the GitHub API.
Endpoint Kind
Use github as the endpoint kind when creating this endpoint through the API or dashboard.
What Eve Uses This Endpoint For
- Allow approved agents to inspect repositories, issues, and pull requests.
- Centralize GitHub token handling and audit activity.
- Build workflows that connect code context with incidents, docs, and deployment data.
- Support self-hosted GitHub Enterprise by configuring a base URL.
Basic Endpoint Shape
json
{
"endpoint": "github-prod",
"kind": "github",
"config": {
"read_conn": {
"token": "secret",
"base_url": "https://api.github.com"
}
}
}Create it with the endpoint API:
bash
curl -sS -X POST "$EDEN/endpoints" \
-H "$AUTH_HEADER" \
-H "Content-Type: application/json" \
-d '{
"endpoint": "github-prod",
"kind": "github",
"config": {
"read_conn": {
"token": "secret",
"base_url": "https://api.github.com"
}
}
}'Configuration Fields
| Field | Purpose |
|---|---|
token | Personal access token, fine-grained token, or app token |
base_url | Optional API base URL for GitHub Enterprise |
Operating Notes
- Prefer GitHub App or fine-grained tokens over broad personal access tokens.
- Restrict repository scopes to the automation use case.
- Treat write scopes as production-change authority and gate them carefully.
Related
Last updated: October 20, 2018