Skip to content
GET/api/v1/integrations/github-app

Get GitHub App installation status

Returns the org's GitHub App installation state. `?orgId` is required (400 MISSING_ORG_ID) and the key must carry the `settings:read` scope. Reads the newest `status='active'` row from `github_app_installations`; if none exists it returns `{installed:false, ...nulls, repos:[], checkRuns:[], installUrl}` where `installUrl` is the App install URL with `state=org:<orgId>` so the callback can bind the installation. When installed it returns `{installed:true, installationId, accountLogin, accountType, repos, checkRuns:[], installUrl:null}`. `repos` is fetched live from GitHub (up to 50) via the installation token, but only when `GITHUB_APP_ID` and `GITHUB_APP_PRIVATE_KEY` are configured — a GitHub API failure or missing env degrades to an empty list rather than a 500, and `configFound` on each repo is always false (the per-repo evalguard.yaml probe is skipped for render speed). `checkRuns` is always empty — not yet wired. App permissions and webhook health are not reported. 60 req/min.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Response

200 example

{
  "success": true
}

All status codes

200Status.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/integrations/github-app \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/integrations/github-app", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("GET", "https://evalguard.ai/api/v1/integrations/github-app", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/integrations/github-app", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Integrations endpoints