Agent Status APIs

Get Agents Summary

• Description – Gets the agent's summary.

• Request URL – GET /cablevalidation/nodes/agents/summary

• Request Paramscluster:  Name of the cluster. If set, the response will return the agent details for that specific cluster.Type - stringOptional - trueDefault - default

• Response Content Type – application/json

• Status Codes200 – OK

• Response Data Example 

  {
      "total_device_count": 1,
      "correct_agent_version_installed": 1,
      "no_ping": 0,
      "no_json_api": 0,
      "no_agent": 0,
      "wrong_agent_version": 0,
      "no_reports": 0,
      "late_reports": 0,
      "stale_reports": 0,
      "expected_agent": "1.6.0-3",
      "comment": ""
  }

Get Agents Details

• Description – Gets the agent's summary.

• Request URL – GET /cablevalidation/nodes/agents/details

• Request Paramscluster:  Name of the cluster. If set, the response will return the agent details for that specific cluster.Type - stringOptional - TrueDefault - defaultcontext: one of the following: dc, dh, su, rack, or node.Type - stringOptional - Falseitems - The report scope, which typically includes a list of data-halls, scalable-unit/data-hall, racks, or nodes, depending on the selected context. Do not include this item if the context is "dc". Type - comma-separated stringOptional - False (not included for DC context).Examples:context=su&items=DH1/SU1,DH1/SU2context=dh&items=DH1,DH2context=rack&items=PXH,PXX

• Response Content Type – application/json

• Status Codes200 – OK404 - Not Found

• Response Data Example 

  [
      {
          "hostname": "sw-hdr-proton01.mtr.labs.mlnx",
          "ip": "10.209.44.74",
          "ping": true,
          "json_api": "True",
          "agent": "1.6.0-3",
          "node_type": "Switch",
          "comment": "",
          "last_updated": 1754220100,
          "time_since_update": 3.36,
          "dh": null,
          "su": null,
          "rack": "PXX",
          "unit": 27
      }
  ]

Last updated: June 03, 2026