API ReferenceREST API Reference
REST API Reference
REST API endpoint reference and authentication.
REST API Reference
Valqore exposes a REST API for programmatic access to governance evaluation, cluster scanning, compliance, and more.
Base URL
http://localhost:8000Override with VALQORE_API_URL for remote deployments.
Start the Server
valqore serve --host 0.0.0.0 --port 8000Endpoints
| Method | Path | Description |
|---|---|---|
POST | /api/v1/evaluate | Evaluate manifests against governance rules |
POST | /api/v1/scan | Scan a live Kubernetes cluster |
POST | /api/v1/validate | Compare current vs proposed configuration |
GET | /api/v1/rules | List all governance rules |
GET | /api/v1/compliance | Compliance framework mappings |
GET | /api/v1/health | Health check |
POST | /api/v1/carbon/estimate | Carbon footprint estimation |
POST | /api/v1/carbon/report | Carbon report generation |
GET | /api/v1/scores/history | Score trending over time |
GET | /api/v1/scores/trend | Score trend analysis |
POST | /api/v1/finops/anomalies | Cost anomaly detection |
POST | /api/v1/finops/forecast | Cost forecasting |
POST | /api/v1/webhook | Kubernetes admission webhook |
Authentication
Pass the API key in the X-API-Key header:
curl -X POST http://localhost:8000/api/v1/evaluate \
-H "X-API-Key: your-api-key-here" \
-H "Content-Type: application/json" \
-d '{ ... }'Was this helpful?