1.3.0 (2023-11-16)

------------------
* [new] Fortigate.get_l()

Author: vladimirs-git

CHANGELOG.rst

@@ -4,6 +4,11 @@
 CHANGELOG
 =========
 
+1.3.0 (2023-11-16)
+------------------
+* [new] Fortigate.get_l()
+
+
 1.2.5 (2023-11-06)
 ------------------
 * [fix] Look for a cookie that is named "ccsrftoken" or stars with "ccsrftoken_".

README.rst

@@ -47,7 +47,7 @@ or install the package from github.com release
 
 .. code:: bash
 
-    pip install https://github.com/vladimirs-git/fortigate-api/archive/refs/tags/1.2.5.tar.gz
+    pip install https://github.com/vladimirs-git/fortigate-api/archive/refs/tags/1.3.0.tar.gz
 
 or install the package from github.com repository
 
@@ -943,7 +943,8 @@ Return
 
 get()
 .....
-**Fortigate.get(url)** GET object configured in the Fortigate
+**Fortigate.get(url)** GET object configured in the Fortigate.
+Fortigate returns dictionary with key="results".
 
 =============== ======= ============================================================================
 Parameter       Type    Description
@@ -955,6 +956,21 @@ Return
     *List[dict]* of the objects data
 
 
+get_l()
+.....
+**Fortigate.get_l(url)** GET list of objects.
+Fortigate returns list of items.
+
+=============== ======= ============================================================================
+Parameter       Type    Description
+=============== ======= ============================================================================
+url             *str*   REST API URL
+=============== ======= ============================================================================
+
+Return
+    *List[dict]* of the objects
+
+
 post()
 ......
 **Fortigate.post(url, data)** POST (create) object in the Fortigate based on the data

examples/fortigate.py

@@ -81,6 +81,18 @@
 #   'crscore': 30,
 # ...
 
+# Get list
+output = fgt.get_l(url="/api/v2/monitor/firewall/policy?global=1")
+pprint(output)
+# [{'build': 2093,
+#   'http_method': 'GET',
+#   'name': 'policy',
+#   'path': 'firewall',
+#   'results': [{'active_sessions': 0,
+#                'asic_bytes': 0,
+#                'asic_packets': 0,
+# ...
+
 
 # Get Directory
 output = fgt.directory(url="/api/v2/log")

fortigate_api/fortigate.py

@@ -277,19 +277,36 @@ def exist(self, url: str) -> Response:
     def get(self, url: str) -> LDAny:
         """GET object configured in the Fortigate.
 
-        ::
-            :param url: REST API URL to the object
-            :type url: str
+        Fortigate returns dictionary with key="results".
+        :param url: REST API URL to the object
+        :type url: str
 
-            :return: List of the Fortigate objects
-            :rtype: List[dict]
+        :return: List of the Fortigate objects
+        :rtype: List[dict]
         """
         response: Response = self._response("get", url)
         if not response.ok:
             logging.info("code=%s, reason=%s, url=%s", response.status_code, response.reason, url)
             return []
         response_json = response.json()
-        results: LDAny = response_json.get("results") or []
+        results: LDAny = list(response_json.get("results") or [])
+        return results
+
+    def get_l(self, url: str) -> list:
+        """GET list of objects.
+
+        Fortigate returns list of items.
+        :param url: REST API URL
+        :type url: str
+
+        :return: List of the objects
+        :rtype: List[dict]
+        """
+        response: Response = self._response("get", url)
+        if not response.ok:
+            logging.info("code=%s, reason=%s, url=%s", response.status_code, response.reason, url)
+            return []
+        results: LDAny = list(response.json() or [])
         return results
 
     def post(self, url: str, data: DAny) -> Response: