API Documentation

Integrate PatchPulse into your workflow

POST /api/v1/change-events
Create a change event and trigger risk analysis. Returns a decision with risk score and guardrail results.
{ "source": "github", "repo": "org/repo", "sha": "abc123", "pr_number": 42, "branch": "feature-branch", "files": ["k8s/deployment.yaml"], "diff_hunks": [...], "timestamp": "2026-01-01T00:00:00Z" }
GET /api/v1/decisions
List recent decisions with risk scores and guardrail results. Supports filtering and pagination.
GET /api/v1/analytics/summary
Get analytics summary including total decisions, blocked count, average risk score, and top guardrails.
GET /api/v1/analytics/risk-trend
Get risk score trends over time. Useful for tracking risk patterns and improvements.
GET /api/v1/export/decisions
Export decisions to CSV or JSON format. Supports filtering and pagination for compliance and analysis.
GET /api/v1/export/analytics
Export comprehensive analytics report with summary statistics, guardrail metrics, and decision history.
POST /api/v1/webhooks
Create webhooks for outbound notifications. Configure event types, custom headers, and webhook secrets.
POST /api/v1/decisions/{id}/approve
Manually approve a high-risk decision. Supports approver tracking and comments for audit trail.
POST /api/v1/decisions/bulk
Perform bulk operations on multiple decisions. Approve, reject, or delete decisions in batch.
POST /api/v1/change-events/compare
Compare two change events side-by-side. Analyze differences, risk changes, and get recommendations.
GET /api/v1/audit
Get comprehensive audit log of all decisions and actions. Filter by date range and export for compliance.
GET /api/v1/integrations
List all available integrations (Teams, Email, PagerDuty) and their configuration status.
POST /api/v1/integrations/{type}/test
Test an integration configuration. Verify Teams, Email, or PagerDuty integration setup.

Interactive API Docs

Explore the full API with interactive documentation, try endpoints, and see responses.

Open Interactive API Docs →