Overview#
Base URL#
http://localhost:3001/api/v1
Authentication#
All API endpoints require authentication via JWT token:
Authorization: Bearer <your-jwt-token>
Endpoints#
POST /v1/security/events#
Ingest a security monitoring event
Parameters: None
Responses:
- 200: Event accepted for aggregation
- 400: No description
- 500: No description
Operation ID: securityEventIngest
GET /v1/security/dashboard#
Security monitoring dashboard
Parameters: None
Responses:
- 200: Aggregated security metrics, anomalies, and safety signals
- 500: No description
Operation ID: securityDashboard
GET /v1/apm/overview#
APM overview by service
Parameters: None
Responses:
- 200: Overview with p50/p95/p99
- 500: No description
Operation ID: apmOverview
POST /v1/apm/ingest#
Ingest an APM span or request metric
Parameters: None
Responses:
- 202: Metric accepted for aggregation
- 400: No description
- 500: No description
Operation ID: apmIngest
GET /v1/apm/service/{service}#
Detailed APM statistics for a single service
Parameters:
service(path): No description
Responses:
- 200: Endpoint level latency and error metrics for the service
- 500: No description
Operation ID: apmServiceDetail
GET /v1/apm/traces/{traceId}#
Retrieve a sampled trace summary by traceId
Parameters:
traceId(path): No description
Responses:
- 200: Trace summary when available
- 404: Trace not retained
- 500: No description
Operation ID: apmTraceLookup
GET /v1/metrics/dashboards/business#
Business KPI dashboard
Parameters: None
Responses:
- 200: Dashboard
- 500: No description
Operation ID: businessDashboard
Rate Limiting#
All endpoints are subject to rate limiting:
- Burst limit: 100 requests per minute
- Sustained rate: 1000 requests per hour
Error Handling#
Standard error response format:
{
"error": {
"code": "ERROR_CODE",
"message": "Human readable error message",
"details": {}
}
}
Generated automatically from OpenAPI specification