Dashboard REST APIs | UFM Cable Validation Tool

The Dashboard REST APIs provide the aggregated information displayed by the Operational Dashboard and AI Factory Dashboard. Requests made through the CVT HTTPS proxy use the /cablevalidation prefix shown below.

Get Dashboard Summary

Description – Gets the aggregated data used by the Operational Dashboard, including validation status, topology metadata, agent health, device-status KPIs, issue statistics, circuit statistics, the last precheck time.
Request URL – GET /cablevalidation/dashboard/summary
Response Content Type – application/json
Status Codes
- 200 – OK
- 400 – BAD REQUEST

For administrators, the response also includes buildup_start_time, buildup_go_live_target, and active_operations. These fields are omitted for non-administrator users.

Response Example

JSON

{
  "validation": {
    "status": "started",
    "started_at": 1767225600,
    "started_by": "admin",
    "duration_seconds": 3600,
    "last_cycle_seconds_ago": 12
  },
  "version": "1.4.0",
  "topology": {
    "file_name": "site-topology.xlsx",
    "file_id": "94a8c27f",
    "load_time": 1767225400,
    "switches_count": 32,
    "hosts_count": 96,
    "links_count": 128
  },
  "agents": {
    "total_device_count": 128,
    "correct_agent_version_installed": 120,
    "no_ping": 2,
    "no_agent": 4,
    "late_reports": 1,
    "stale_reports": 1
  },
  "device_status": {
    "period": "today",
    "total_devices": 128,
    "statuses": {
      "production": {
        "count": 80,
        "change": 6,
        "direction": 1
      },
      "validating": {
        "count": 20,
        "change": 2,
        "direction": 1
      }
    }
  },
  "issues_summary": [
    {
      "syndrome": "Link Down, No signal",
      "number_of_occurrences": 3,
      "switches_affected": 2,
      "number_of_occurrences_from_stale": 1,
      "switches_affected_from_stale": 1,
      "change": -1,
      "direction": -1,
      "change_period_minutes": 60
    }
  ],
  "circuits_stats": {
    "total_circuits": 128,
    "healthy_circuits": 110,
    "unhealthy_circuits": 12,
    "not_active_circuits": 6
  },
  "last_precheck_ts": 1767225300,
  "scope": {
    deployment_id: null,
    device_count: null,
    is_entire_file: true,
    workspace_id: null,
  },
  "buildup_start_time": 1767225600,
  "buildup_go_live_target": 1768435200,
  "active_operations": []
}

Get Port-Issue History

Description – Gets the port-issue history used by the Operational Dashboard chart. The response is ordered by time and includes the most recent live point when data is available.
Request URL – GET /cablevalidation/dashboard/port-issue-history
Request Parameters
- range – Time range to return. Supported values: 1h, 6h, 24h, and 7d.
  - Type: string
  - Optional: true
  - Default: 7d
Response Content Type – application/json
Status Codes
- 200 – OK
- 400 – BAD REQUEST
Response Example

JSON

[
  {
    "timestamp": 1767222000,
    "total_issues": 15,
    "total_devices": 128,
    "validating_devices": 22
  },
  {
    "timestamp": 1767225600,
    "total_issues": 12,
    "total_devices": 128,
    "validating_devices": 20
  }
]

Get Build-Up Progress

Description – Gets device-status history for the AI Factory Dashboard build-up progress chart. Device statuses are grouped as follows:
- production – Production and Production Ready.
- validating – Validating.
- setup – Not Provisioned, Provisioned, Agent Ready, and Validation Ready.
- not_ready – Not Installed, Installed No Power, Unsupported, Undefined, and Validation Only.
- maintenance – Maintenance and Drain/Troubleshooting.
- unmanaged – Unmanaged.
Request URL – GET /cablevalidation/dashboard/buildup-progress
Access – Administrator only.
Request Parameters
- range – Supported values: 6h, 24h, 7d, and 30d.
  - Type: string
  - Optional: true
  - Default: 7d
- resolution – Supported values: 5 minutes, 15 minutes, 1 hour, 6 hours, and 1 day. If omitted, the service selects a resolution appropriate for the requested range.
  - Type: string
  - Optional: true
Response Content Type – application/json
Status Codes
- 200 – OK
- 400 – BAD REQUEST
- 401 – UNAUTHORIZED
- 403 – FORBIDDEN
Response Example

JSON

{
  "timestamps": [1767222000, 1767225600],
  "series": {
    "production": [74, 80],
    "validating": [24, 20],
    "setup": [20, 18],
    "not_ready": [6, 4],
    "maintenance": [2, 2],
    "unmanaged": [2, 4]
  },
  "total_nodes": [128, 128],
  "range": "7d",
  "resolution": "1 hour"
}

Get Build-Up Velocity

Description – Gets production-readiness velocity statistics for the AI Factory Dashboard. Production and Production Ready devices are included in the production total. The calculation uses up to 30 days of build-up history.
Request URL – GET /cablevalidation/dashboard/buildup-velocity
Access – Administrator only.
Response Content Type – application/json
Status Codes
- 200 – OK
- 400 – BAD REQUEST
- 401 – UNAUTHORIZED
- 403 – FORBIDDEN
Response Example

JSON

{
  "average": 8.4,
  "days": 14,
  "today": 6,
  "yesterday": 9,
  "peak": 14,
  "min": 3,
  "remaining": 48,
  "total_nodes": 128,
  "unit": "Nodes/Day"
}

Update Build-Up Timestamps

Description – Updates the build-up start time, go-live target, or both. Values are Unix timestamps in seconds. An omitted field remains unchanged.
Request URL – PUT /cablevalidation/dashboard/buildup-timestamps
Access – Administrator only.
Request Content Type – application/json
Response Content Type – application/json
Validation Rules
- Each supplied value must be a positive numeric Unix timestamp in seconds.
- The go-live target cannot be earlier than the build-up start time.
- The go-live target must be within one year of the build-up start time.
Status Codes
- 200 – OK
- 400 – BAD REQUEST
- 401 – UNAUTHORIZED
- 403 – FORBIDDEN
Request Example

JSON

{
  "buildup_start_time": 1767225600,
  "buildup_go_live_target": 1768435200
}

Response Example

JSON

{
  "buildup_start_time": 1767225600,
  "buildup_go_live_target": 1768435200
}

Last updated: August 27, 2026