Export trusted traffic to a CSV or JSON file

Export trusted traffic to a CSV or JSON file.

Method requires value of parameter firewallName. Use the device-setup-controller API Get /devices method to return it.

Resource Name: /api/v1//trustedTraffic/firewalls/{firewallName}

Request Method: GET

Request Parameters:

Element

Type

Description
exportFormat optional string

One of the following::

  • CSV (default)
  • JSON
firewallName Mandatory

String

Firewall name. Use the device-setup-controller API GET /devices method to return or use ALL_FIREWALLS.

includeSubEntities Boolean

  • true (default) All data from child levels will be included

  • false No child data included

Request body parameters

Element Type Description

pageSize

Optional

Integer

The number of rows to display per page in the output JSON file.

Tip: By default, rules with zero hits are not shown in the results, although the user is notified that these rules exist.

To include rules with zero hit counts in the response, increase the pageSize parameter in the API enough to fit all the rules onto a single page.

page

Optional

Integer

The page to display in the output JSON file.

Response:

Code

Description
200

Operation completed successfully. Download link is provided.
400 invalid device name

401

Unauthorized

Request cURL examples 

Export-curl -X GET "https://[machine IP]/afa/api/v1/trustedTraffic/firewalls/ALL_FIREWALLS/export?exportFormat=CSV&includeSubEntities=true&pageNo=0&pageSize=10" -H "accept: */*"

Response example in JSON Format 

. {
  "global": {},
  "groups": {},
  "device": {
    "10_20_244_1_99_Customer01": {
      "965": {
        "source": "10.10.10.10",
        "destination": "Any",
        "service": "YooService",
        "comment": "Defined service retoo",
        "trust_future_host_group_changes": true,
        "compatible_trusted_traffic_id": "qN7iMm2doN6Hs"
      },
      "994": {
        "source": "Any",
        "destination": "Any",
        "expirationDate": 0,
        "service": "udp",
        "trust_future_host_group_changes": false,
        "compatible_trusted_traffic_id": "R1NZWG0Tx0JiY"
      },
      "995": {
        "source": "Billing/web",
        "destination": "AP1/EPG1",
        "expirationDate": 0,
        "service": "default",
        "comment": "Trust future changes. Rule 10_20_244_1_99_Customer01, added by admin on 2020/08/12",
        "trust_future_host_group_changes": false,
        "compatible_trusted_traffic_id": "CsCEzA2LNMfWy"
      },
      "3155": {
        "source": "AP1_EPG1",
        "destination": "Billing_app",
        "service": "YooService",
        "trust_future_host_group_changes": false,
        "compatible_trusted_traffic_id": "KiZp1mAsocWw7"
      }
    }
  }
}

Related topics

Trusted Traffic Data APIs