Technical Tip: How to get SD-WAN Monitoring data via API

Description

This article describes how to gather the data required for FortiManager to generate the per-device SD-WAN monitoring view through the SD-WAN widget via API.

Scope

FortiManager.

Solution

Retrieve the data directly from managed FortiGate devices through the FortiOS REST API using the sys/proxy/json endpoint available in the FortiManager API.

However, FortiManager already performs these queries periodically and stores the collected information in local Real Time Monitor (RTM) databases, allowing extended monitoring history within the FortiManager GUI.

The following examples demonstrate how to retrieve two SD-WAN monitoring metrics for the test1 device.

Request:

{
  "id": 3,
  "method": "get",
  "params": [
    {
      "filter": {
        "key": [
          [
            "name"
          ],
          [
            "interface"
          ]
        ],
        "timestamp": [
          [
            "start",
            "==",
            1707250230
          ],
          [
            "end",
            "==",
            1707253230
          ]
        ]
      },
      "url": "/rtm/global/rhistory/monitor/sd-wan-sla-log/device/test1"
    }
  ],
  "session": "{{session}}"
}

Response:

{
  "id": 3,
  "result": [
    {
      "data": [
        {
          "interface": "port10",
          "log": [
            {
              "timestamp": 170725230,
              "value": {
                "jitter": 0.1982,
                "latency": 1.003067,
                "link": "up",
                "packetloss": 0.0
              }
            },
            {
              "timestamp": 1707250244,
              "value": {
                "jitter": 0.230633,
                "latency": 2.498699,
                "link": "up",
                "packetloss": 0.0
              }
            },
            {
              "timestamp": 1707250244,
              "value": {
                "jitter": 0.378133,
                "latency": 2.459866,
                "link": "up",
                "packetloss": 0.0
              }
            },

Troubleshooting:

The following commands can be used on the FortiManager CLI to debug the API Calls:

diagnose debug service httpd 255
diagnose debug service main 255
diagnose debug enable