Flow Tracker Capture Management
The endpoints are applicable for IOTA Edge system only.
/consumers/flow_tracker/configGETjson { "message": "Success", "data": { "enable_stage4": true, "enable_l2_tag_correlation": true, "enable_reordering": false } }GET /v1/dispatcher/config?dispatcher_id=1 (flow-tracker/dispatcher_manager.html)/consumers/flow_tracker/configPUTjson { "enable_stage4": true, "enable_l2_tag_correlation": true, "enable_reordering": false }messagePUT /v1/dispatcher/config?dispatcher_id=1 (flow-tracker/dispatcher_manager.html)custom_session_key:
/consumers/flow_tracker/custom_session_keyGETjson { "message":"Success", "data": { "custom_session_key":"Session" } }custom_session_key:
/consumers/flow_tracker/custom_session_keyPUTjson { "custom_session_key":"Session" }messagePUT /v1/dispatcher/config (flow-tracker/dispatcher_manager.html)/consumers/flow_tracker/queueGETjson { "message": "Success", "data": { "queue_id": 1, "size": 3 } }GET /v1/queue?queue_id=1 (flow-tracker/queue_manager.html)/consumers/flow_tracker/queueGETlist=true (optional, false by default)json { "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" ] } }GET /v1/queue?queue_id=1&list=true (flow-tracker/queue_manager.html)/consumers/flow_tracker/queuePOSTjson [ "/data/profisight/captures/capture_fc0fe719a2b3_00194_20240108104930.pcapng", "/data/profisight/captures/capture_fc0fe719a2b3_00195_20240108105000.pcapng", "/data/profisight/captures/capture_fc0fe719a2b3_00196_20240108105030.pcapng" ]messagePOST /v1/queue?queue_id=1 (flow-tracker/queue_manager.html)/consumers/flow_tracker/queueDELETEmessageDELETE /v1/queue?queue_id=1 (flow-tracker/queue_manager.html)/consumers/flow_trackerGETjson { "message":"Success", "data": { "subscribed":true } }/consumers/flow_trackerPUTjson { "subscribed":true }messageFlow Tracker Import Management
The endpoints are applicable for both systems IOTA Edge and IOTA Core.
/consumers/flow_tracker/import_configGETjson { "message": "Success", "data": { "enable_stage4": true, "enable_l2_tag_correlation": true, "enable_reordering": false } }GET /v1/dispatcher/config?dispatcher_id=0 (flow-tracker/dispatcher_manager.html)/consumers/flow_tracker/import_configPUTjson { "enable_stage4": true, "enable_l2_tag_correlation": true, "enable_reordering": false }messagePUT /v1/dispatcher/config?dispatcher_id=0 (flow-tracker/dispatcher_manager.html)/consumers/flow_tracker/import_queueGETjson { "message": "Success", "data": { "queue_id": 0, "size": 3 } }GET /v1/queue?queue_id=0 (flow-tracker/queue_manager.html)/consumers/flow_tracker/import_queueGETlist=true (optional, false by default)json { "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" ] } }GET /v1/queue?queue_id=0&list=true (flow-tracker/queue_manager.html)/consumers/flow_tracker/import_queuePOSTjson [ "/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" ]message/consumers/flow_tracker/import_queueDELETEmessageDELETE /v1/queue?queue_id=0 (flow-tracker/queue_manager.html)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.