/api/v1/firmware-pipeline-runs
All endpoints require authentication and a workspace_id query parameter (or resolved from session context).
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
HTTP API for OTA workflow runs and fleet rollout control
/api/v1/firmware-pipeline-runs
All endpoints require authentication and a workspace_id query parameter (or resolved from session context).
GET /api/v1/firmware-pipeline-runs?workspace_id={uuid}&limit=20&page=1
| Field | Description |
|---|---|
fleet_target_count | Total compatible devices in the rollout. |
fleet_progress_percent | Fleet-wide completion percent. |
rollout_strategy | all_at_once, canary, or staged_expand. |
rollout_phase | canary, expand, or full. |
expand_stages | Configured stage percents. |
current_target_percent | Active stage percent. |
wave_index | Latest wave number (on wave child runs). |
GET /api/v1/firmware-pipeline-runs/{id}?workspace_id={uuid}
POST /api/v1/firmware-pipeline-runs/{id}/approve?workspace_id={uuid}
POST /api/v1/firmware-pipeline-runs/{id}/pause?workspace_id={uuid}
POST /api/v1/firmware-pipeline-runs/{id}/resume?workspace_id={uuid}
POST /api/v1/firmware-pipeline-runs/{id}/abort?workspace_id={uuid}
POST /api/v1/firmware-pipeline-runs/{id}/cancel?workspace_id={uuid}
POST /api/v1/firmware-pipeline-runs/{id}/retry?workspace_id={uuid}
Content-Type: application/json
{
"workspace_id": "{uuid}",
"device_ids": ["{device-uuid}", "..."]
}
POST /api/v1/firmwares/{firmware_id}/batch-deploy?workspace_id={uuid}
Content-Type: application/json
{
"device_template_id": "{uuid}",
"device_ids": ["{optional-device-uuid}"],
"scheduled_at": "2026-07-16T10:00:00Z"
}