REST: Monitor Workloads¶
This page indexes the REST endpoints the Workload API exposes for monitoring a Workload: statistics, lifecycle events, and replacement history. Application OpenTelemetry telemetry (traces, logs, metrics emitted by your container) is exposed through a separate observability surface and is not proxied by the Workload API; for the Console views, see Monitor deployed Workloads and View deployed Workload activity.
Statistics¶
The following endpoints return aggregated and time-series request statistics, with optional reset by proton or time window.
| Verb | Path | Description |
|---|---|---|
GET |
/workloads/stats |
Aggregated statistics across all accessible Workloads. Same filters as GET /workloads. |
GET |
/workloads/{workload_id}/stats |
Aggregated request statistics for one Workload. Optional protonId, startTime, endTime, responseTimeQuantile (default 0.5), slowRequestsThreshold (default 2000 ms). |
GET |
/workloads/{workload_id}/stats/{metric_name} |
Time-series for a single metric. metric_name ∈ totalRequests, requestsOverN, requestsPerMinute, concurrentRequests, responseTime, totalErrorRate. Optional resolution (PT1M, PT5M, PT1H, P1D, P7D, P1M; default P1D). |
DELETE |
/workloads/{workload_id}/stats |
Reset Workload statistics. Optional protonId, startTime, endTime for partial windows. |
Events and history¶
These endpoints expose the lifecycle event stream and the Workload's replacement history.
| Verb | Path | Description |
|---|---|---|
GET |
/workloads/{workload_id}/events |
List lifecycle events (status changes, errors) for a Workload. |
GET |
/workloads/{workload_id}/history |
List the Workload's replacement history (ReplacementHistoryListResponse). |
See Monitoring concepts for retention and access semantics.