Fortinet white logo
Fortinet white logo

SysStatusUsage

SysStatusUsage

FortiRecorder system resource usage information such as CPU usage in percent, disk space usage in percent , and network bandwidth usage. See also SysStatusSysinfo.

Historical usage data such as cpu_history can be used to generate charts and graphs with third-party tools.

Permissions required include System status.

HTTP Methods
  • GET

URL
https://HOST_OR_IP/api/v1/SysStatusUsage/

Response JSON

{
    "objectID": "SysStatusUsage:",
    "reqAction": 1,
    "nodePermission": 3,
    "cpu": 8,
    "memory": 43,
    "log_disk": 2,
    "mail_disk": 90,
    "system_load": 15,
    "active_sessions": 26,
    "network_usage": 11200,
    "cpu_history": "{
        "values": [8, 10, 9, 10, 10, 10, 10, 10, 9, 9, 8, 9, 10, 9, 10, 9, 8, 8, 8, 9, 9, 9, 10, 9, 8, 8, 10, 9, 8, 8, 8],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_legend": "%",
        "y_step": 10,
        "y_max": 100
    }",
    "memory_history": "{
        "values": [43, 49, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_legend": "%",
        "y_step": 10,
        "y_max": 100
    }",
    "session_history": "{
        "values": [26, 26, 25, 26, 26, 24, 25, 26, 24, 25, 26, 25, 27, 26, 25, 26, 26, 25, 26, 26, 25, 25, 26, 25, 26, 25, 25, 25, 27, 25, 26],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_step": 10,
        "y_max": 30
    }",
    "network_history": "{
        "values": [11200, 14569, 14791, 14838, 14962, 14768, 14652, 14770, 14800, 14656, 14446, 14506, 14777, 14648, 14232, 13236, 13327, 13315, 13213, 13138, 13092, 13076, 12802, 12162, 11159, 11409, 11324, 11193, 11296, 11525, 11200],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_legend": "Kbps",
        "y_step": 10000,
        "y_max": 20000
    }",
    "remote_video_disk": 0
}

where attributes often self-explanatory, except:

  • cpu_history etc. — Array of values, units (x_labels etc.) and legend on the X- and Y-axis, and the maximum scale of the Y-axis.

  • network_usage — Bandwidth usage in kilobits per second (Kbps).

SysStatusUsage

SysStatusUsage

FortiRecorder system resource usage information such as CPU usage in percent, disk space usage in percent , and network bandwidth usage. See also SysStatusSysinfo.

Historical usage data such as cpu_history can be used to generate charts and graphs with third-party tools.

Permissions required include System status.

HTTP Methods
  • GET

URL
https://HOST_OR_IP/api/v1/SysStatusUsage/

Response JSON

{
    "objectID": "SysStatusUsage:",
    "reqAction": 1,
    "nodePermission": 3,
    "cpu": 8,
    "memory": 43,
    "log_disk": 2,
    "mail_disk": 90,
    "system_load": 15,
    "active_sessions": 26,
    "network_usage": 11200,
    "cpu_history": "{
        "values": [8, 10, 9, 10, 10, 10, 10, 10, 9, 9, 8, 9, 10, 9, 10, 9, 8, 8, 8, 9, 9, 9, 10, 9, 8, 8, 10, 9, 8, 8, 8],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_legend": "%",
        "y_step": 10,
        "y_max": 100
    }",
    "memory_history": "{
        "values": [43, 49, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43, 43],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_legend": "%",
        "y_step": 10,
        "y_max": 100
    }",
    "session_history": "{
        "values": [26, 26, 25, 26, 26, 24, 25, 26, 24, 25, 26, 25, 27, 26, 25, 26, 26, 25, 26, 26, 25, 25, 26, 25, 26, 25, 25, 25, 27, 25, 26],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_step": 10,
        "y_max": 30
    }",
    "network_history": "{
        "values": [11200, 14569, 14791, 14838, 14962, 14768, 14652, 14770, 14800, 14656, 14446, 14506, 14777, 14648, 14232, 13236, 13327, 13315, 13213, 13138, 13092, 13076, 12802, 12162, 11159, 11409, 11324, 11193, 11296, 11525, 11200],
        "x_labels": ["15:17:40", "15:18:00", "15:18:20", "15:18:40", "15:19:00", "15:19:20", "15:19:40", "15:20:00", "15:20:20", "15:20:40", "15:21:00", "15:21:20", "15:21:40", "15:22:00", "15:22:20", "15:22:40", "15:23:00", "15:23:20", "15:23:40", "15:24:00", "15:24:20", "15:24:40", "15:25:00", "15:25:20", "15:25:40", "15:26:00", "15:26:20", "15:26:40", "15:27:00", "15:27:20", "15:27:40"],
        "y_legend": "Kbps",
        "y_step": 10000,
        "y_max": 20000
    }",
    "remote_video_disk": 0
}

where attributes often self-explanatory, except:

  • cpu_history etc. — Array of values, units (x_labels etc.) and legend on the X- and Y-axis, and the maximum scale of the Y-axis.

  • network_usage — Bandwidth usage in kilobits per second (Kbps).