Capture Sessions

Manage capture sessions of the system

API

• Get all capture session of the system:

  • Path: /capture_sessions

  • Method: GET

  • Minimum user role: viewer

  • Response:

    [
        {
            "id": 1,
            "capture_enabled": false,
            "name": "Port 1 Capture Session",
            "colour": "008000",
            "settings": {
                "enable_stage4": true,
                "enable_l2_tag_correlation": false,
                "enable_reordering": false
            },
            "interfaces": [
                1
            ],
            "queue_size": 5
        }
    ]

    • id - unique ID of the capture session
    • capture_enabled - if capture is enabled for this capture session
    • name - name of the capture session
    • colour - colour of the label of this capture session; only the following colours are allowed: ['007bff', '1034a6', '1111e8', '000080', '6a5acd', 'b14b34', 'c62e69', 'ff00ff', '14452f', '3c206e', '260069']
    • settings - settings to be passed to the analyzer (flow-tracker)
    • interfaces - interfaces, attached to this capture session; the number of interfaces in a single capture session is limited by the configured number of concurrent capture ports (1-4, default: 4), see System Resources
    • queue_size - total size of all flow-tracker input queues which belong the session interfaces
• Create a capture session
  • Path: /capture_sessions
  • Method: POST
  • Minimum user role: operator
  • Request body: capture_session object without id
  • Response: new capture_session object with id or error
  • Notes:
    • the parameter id ignored if presented in the request body
    • in order to create the capture session the request body must include at least the following mandatory fields: name, colour
    • the interfaces can not include the interfaces which belong other session in a running state (capture_enabled is true)
    • the interfaces which belong to the other session in non-running state (capture_enabled is false) will be moved from other session to this one
• Change a capture session
  • Path: /capture_sessions/{ID}
  • Method: PUT
  • Minimum user role: operator
  • Request body: capture_session object with the fields to be changed
  • Response: new capture_session object or error
  • Notes:
    • the parameter id cannot be changed in any way
    • the following parameters can not be changed while session captures (capture_enabled is true): settings, interfaces
    • the following parameters can be changed while session captures (capture_enabled is true): name, colour
    • the interfaces can not include the interfaces which belong other session in a running state (capture_enabled is true)
    • the interfaces which belong to the other session in non-running state (capture_enabled is false) will be moved from other session to this one
    • the endpoint should also be used to start/stop capturing of the capture session (set capture_enabled to true/false)
• Delete a capture session
  • Path: /capture_sessions/{ID}
  • Method: DELETE
  • Minimum user role: operator
  • Response: success message or error
  • Notes:
    • in order to delete the capture session capture must not be running (capture_enabled must be false)

Back to Index