Flow Tracker Consumer

Flow Tracker Capture Management

The endpoints are applicable for IOTA Edge system only.

• Get the captured files dispatcher configuration:

  • Path: /consumers/flow_tracker/config

  • Method: GET

  • Response:

    {
        "message": "Success",
        "data": {
            "enable_stage4": true,
            "enable_l2_tag_correlation": true,
            "enable_reordering": false
        }
    }

  • Notes: sends request to flow-tracker GET /v1/dispatcher/config?dispatcher_id=1

• Change the captured files dispatcher configuration:

  • Path: /consumers/flow_tracker/config

  • Method: PUT

  • Request body:

    {
        "enable_stage4": true,
        "enable_l2_tag_correlation": true,
        "enable_reordering": false
    }

  • Response: success or error message

  • Notes: sends request to flow-tracker PUT /v1/dispatcher/config?dispatcher_id=1

• Get the captured session custom_session_key:

  • Path: /consumers/flow_tracker/custom_session_key

  • Method: GET

  • Response:

    {
        "message":"Success",
        "data": {
            "custom_session_key":"Session"
        }
    }

• Set the captured session custom_session_key:

  • Path: /consumers/flow_tracker/custom_session_key

  • Method: PUT

  • Request body:

    {
        "custom_session_key":"Session"
    }

  • Response: success or error message

  • Notes: sends request to flow-tracker PUT /v1/dispatcher/config

• Get the captured files queue size:

  • Path: /consumers/flow_tracker/queue

  • Method: GET

  • Response:

    {
        "message": "Success",
        "data": {
            "queue_id": 1,
            "size": 3
        }
    }

  • Notes: sends request to flow-tracker GET /v1/queue?queue_id=1

• Get the captured files queue size and content:

  • Path: /consumers/flow_tracker/queue

  • Method: GET

  • Arguments:

    • URL parameters : list=true (optional, false by default)

  • Response:

    {
        "message": "Success",
        "data": {
            "queue_id": 1,
            "size": 3,
            "content": [
                "/data/profisight/captures/capture_fc0fe719a2b3_00194_20240108104930.pcapng",
                "/data/profisight/captures/capture_fc0fe719a2b3_00195_20240108105000.pcapng",
                "/data/profisight/captures/capture_fc0fe719a2b3_00196_20240108105030.pcapng"
            ]
        }
    }

  • Notes: sends request to flow-tracker GET /v1/queue?queue_id=1&list=true

• Add new PCAP-ng file path(s) to the captured files queue:

  • Path: /consumers/flow_tracker/queue

  • Method: POST

  • Request body:

    [
        "/data/profisight/captures/capture_fc0fe719a2b3_00194_20240108104930.pcapng",
        "/data/profisight/captures/capture_fc0fe719a2b3_00195_20240108105000.pcapng",
        "/data/profisight/captures/capture_fc0fe719a2b3_00196_20240108105030.pcapng"
    ]

  • Response: success or error message

  • Notes: sends request to flow-tracker POST /v1/queue?queue_id=1

• Clear the captured files queue:
  • Path: /consumers/flow_tracker/queue
  • Method: DELETE
  • Response: success or error message
  • Notes: sends request to flow-tracker DELETE /v1/queue?queue_id=1
• Get the flow tracker’s subscription state:

  • Path: /consumers/flow_tracker

  • Method: GET

  • Response:

    {
        "message":"Success",
        "data": {
            "subscribed":true
        }
    }

• Set the flow tracker’s subscription state:

  • Path: /consumers/flow_tracker

  • Method: PUT

  • Request body:

    {
        "subscribed":true
    }

  • Response: success or error message

Flow Tracker Import Management

The endpoints are applicable for both systems IOTA Edge and IOTA Core.

• Get the imported files dispatcher configuration:

  • Path: /consumers/flow_tracker/import_config

  • Method: GET

  • Response:

    {
        "message": "Success",
        "data": {
            "enable_stage4": true,
            "enable_l2_tag_correlation": true,
            "enable_reordering": false
        }
    }

  • Notes: sends request to flow-tracker GET /v1/dispatcher/config?dispatcher_id=0

• Change the imported files dispatcher configuration:

  • Path: /consumers/flow_tracker/import_config

  • Method: PUT

  • Request body:

    {
        "enable_stage4": true,
        "enable_l2_tag_correlation": true,
        "enable_reordering": false
    }

  • Response: success or error message

  • Notes: sends request to flow-tracker PUT /v1/dispatcher/config?dispatcher_id=0

• Get the imported files queue size:

  • Path: /consumers/flow_tracker/import_queue

  • Method: GET

  • Response:

    {
        "message": "Success",
        "data": {
            "queue_id": 0,
            "size": 3
        }
    }

  • Notes: sends request to flow-tracker GET /v1/queue?queue_id=0

• Get the imported files queue size and content:

  • Path: /consumers/flow_tracker/import_queue

  • Method: GET

  • Arguments:

    • URL parameters : list=true (optional, false by default)

  • Response:

    {
        "message": "Success",
        "data": {
            "queue_id": 0,
            "size": 3,
            "content": [
                "/data_raid/profisight/captures/imported/capture_801f1239dacd_00012_20210528123450.pcapng",
                "/data_raid/profisight/captures/imported/capture_801f1239dacd_00034_20210528124550.pcapng",
                "/data_raid/profisight/captures/imported/capture_801f1239dacd_00034_20210528124550.pcapng"
            ]
        }
    }

  • Notes: sends request to flow-tracker GET /v1/queue?queue_id=0&list=true

• Add new PCAP-ng file path(s) to the imported files queue:

  • Path: /consumers/flow_tracker/import_queue

  • Method: POST

  • Request body:

    [
        "/data_raid/profisight/captures/imported/capture_801f1239dacd_00012_20210528123450.pcapng",
        "/data_raid/profisight/captures/imported/capture_801f1239dacd_00034_20210528124550.pcapng",
        "/data_raid/profisight/captures/imported/capture_801f1239dacd_00034_20210528124550.pcapng"
    ]

  • Response: success or error message

• Clear the imported files queue:
  • Path: /consumers/flow_tracker/import_queue
  • Method: DELETE
  • Response: success or error message
  • Notes: sends request to flow-tracker DELETE /v1/queue?queue_id=0

Parameters:

• message is a text message of a status of the operation.
• data is an array of queue_info objects.
• enable_stage4 is a flag enables stage4 analysis.
• enable_l2_tag_correlation is a flag allows VLAN/MPLS participate in flow correlation procedure.
• enable_reordering is a flag allows reordering the packets.
• custom_session_key is user defined text description of the session, has null value if not defined.
• list is a boolean flag. Used in get requests: true - include the list of filenames to the response, false - do not include. The argument is optional. The value equals false if not presented in a request.
• queue_id is the indentifier of the queue.
• size is the number of items in the queue.
• content is PCAP-ng file’s paths stored in the queue.

Back to Index