Event REST APIs | UFM Cable Validation Tool

The Event REST APIs provide recent activity for dashboard feeds and detailed information about individual events.

Get Recent Events

Description – Gets recent events for the loaded topology. This endpoint is used for dashboard activity and recent device-transition feeds.
Request URL – GET /cablevalidation/events/recent
Request Parameters
- limit – Maximum number of events to return. If omitted, all matching events are returned.
  - Type: integer
  - Optional: true
- types – Event type to include. Repeat this parameter to request multiple event types, for example: ?types=device_transition&types=issue_detected.
  - Type: string
  - Optional: true
- truncate – When true, long node and issue lists are shortened according to the server preview limit. Use false to request the complete stored event payload.
  - Type: boolean
  - Optional: true
  - Default: true
Supported Event Types
- issue_detected
- issue_resolved
- device_transition
- agent_online
- agent_offline
- validation_started
- validation_stopped
- topology_loaded
- test_started
- test_completed
- circuit_refresh_started
- agents_deployed
- agents_removed
- precheck_started
- precheck_completed

Supported severity values are info, warning, error, and success.

Response Content Type – application/json
Status Codes
- 200 – OK
- 400 – BAD REQUEST
Response Example

JSON

[
  {
    "id": 941,
    "timestamp": 1767225600,
    "event_type": "device_transition",
    "severity": "success",
    "message": "6 devices moved to Production",
    "file_id": "94a8c27f",
    "scope_nodes": ["server-01", "server-02"],
    "scope_nodes_count": 6,
    "details": {
      "from_status": "validating",
      "to_status": "production"
    }
  }
]

Get Event Details

Description – Gets a single event by its identifier.
Request URL – GET /cablevalidation/events/{event_id}
Path Parameters
- event_id – Numeric identifier of the event.
  - Type: integer
  - Required: true
Request Parameters
- truncate – When true, long node and issue lists are shortened according to the server preview limit. Use false to request the complete stored event payload.
  - Type: boolean
  - Optional: true
  - Default: true
Response Content Type – application/json
Status Codes
- 200 – OK
- 400 – BAD REQUEST
- 404 – NOT FOUND
Response Example

JSON

{
  "id": 941,
  "timestamp": 1767225600,
  "event_type": "device_transition",
  "severity": "success",
  "message": "6 devices moved to Production",
  "file_id": "94a8c27f",
  "scope_nodes": ["server-01", "server-02", "server-03"],
  "scope_nodes_count": 6,
  "details": {
    "from_status": "validating",
    "to_status": "production"
  }
}

Last updated: August 27, 2026