Docs / Integrate
API reference
The full interactive reference lives at /docs (Swagger) on your deployment. All endpoints return a standard envelope:
{
"status": "ok" | "error",
"data": { ... },
"error": { "code": "...", "message": "...", "details": {} },
"correlation_id": "uuid"
}Scan endpoints
| POST /scan/github/org | Scan an entire GitHub org |
| POST /scan/github/repo | Scan a single repo |
| POST /scan/github/repos | Scan a list of repos |
| GET /scan/jobs | List all scan jobs |
| GET /scan/jobs/{scan_id} | Get a scan job by ID |
| GET /scan/jobs/{scan_id}/findings | Findings for a scan |
| GET /scan/dashboard | Aggregated dashboard summary |
Agent lifecycle endpoints
Require the X-Periscope-API-Key header.
| POST /agent/run/new | Start a new agent run |
| GET /agent/runs | List agent runs |
| GET /agent/findings | Query findings with filters |
| POST /agent/findings/{id}/validate | Trigger validation |
| POST /agent/findings/{id}/approve · /reject | Approve / reject a remediation |
| POST /agent/findings/{id}/suppress | Suppress a finding |
Findings & system
| POST /findings/{id}/reveal | Reveal the decrypted secret — rate-limited (10 / 60 s per user), audited, reason required |
| GET /health | Health check |
| GET /system/info | App version, DB dialect, feature flags |
Source: backend/README.md (API reference) · OpenAPI at /docs on a running deployment