Metrics API
Metrics submission and aggregation
You're viewing a development version of manager,
the latest released version is v1.4.1
Page not available in that version
The current page Metrics API doesn't exist in version v1.4.1 of the documentation for this product.
We can take you to the closest parent section instead: /docs/acd/components/manager/v1.4.1/api_guide/
Overview
The Metrics API allows submission and retrieval of metrics data from CDN components.
Base URL
https://<manager-host>/api/v1/metrics
Endpoints
POST /api/v1/metrics
Submit metrics data.
Request:
{
"example.com": {
"metric1": 100,
"metric2": 200
}
}
Success: 200 OK
Errors: 500 - Validation/backend errors
Example:
curl -s -X POST "https://cdn-manager/api/v1/metrics" \
-H "Content-Type: application/json" \
-d '{
"example.com": {
"metric1": 100,
"metric2": 200
}
}'
GET /api/v1/metrics
Return aggregated metrics per host.
Response: JSON object with aggregated metrics per host
Note: Metrics are stored per host for up to 5 minutes. Hosts that stop reporting disappear from aggregation after that window. When no metrics are being reported, returns empty object {}.
Example:
curl -s "https://cdn-manager/api/v1/metrics"
Metrics Retention
- Metrics are stored for up to 5 minutes in the aggregation layer
- For long-term metrics storage, data is forwarded to VictoriaMetrics
- Query historical metrics via Grafana dashboards at
/grafana
Next Steps
- Configuration API - Configuration document management
- Operator UI API - Blocked tokens, user agents, and referrers
- OpenAPI Specification - Complete API specification