Global Configuration

Allows to configure and inspect the state of the whole system

Endpoints

• Get the current configuration and state:

  • Path: /api/ftng/config

  • Method: GET

  • Response on Success (200 OK):

    {
        "state": string, // possible values: "ready", "capturing", "updating", "waiting_gps".
        "capture_enabled": bool, // whether user has configured the capture to be running or not. if capture has failed to run, this will automatically be updated to false.
        "session_name": string, // arbitrary user-provided name for the session's capture+profile.
        "session_start_timestamp": string, // automatically changes when capture is started. format: `%Y%m%d%H%M%S%8N` (yyyymmddHHMMSSNNNNNNNN) example: 2024100117183482535160
        "analysis_packet_reordering": bool,
        "analysis_mode": string, // possible values: flow, deep
        "analysis_advanced_tcp_enabled": bool,
        "analysis_advanced_dns_enabled": bool,
        "analysis_advanced_http_enabled": bool,
        "analysis_advanced_rtp_enabled": bool,
        "vlan_mpls_tag_correlation": bool, // whether to differentiate flows by vlan/mpls tags/labels too.
        "flow_sampling_interval_s": positive_integer, // interval seconds between intermediate flow statistic dumps.
        "available_flow_sampling_interval_s": [positive_integer, ...], // allowed values for the `flow_sampling_interval_s`.
    }

• Update the current configuration and state:

  • NOTE: this can be used to start/stop capture with the capture_enabled field.

  • NOTE: when the system is in capturing state, then an update request will fail.

  • NOTE: when the system is in updating state, it will wait until the update is done and then apply the requested update and return results.

  • Path: /api/ftng/config

  • Method: PUT

  • Request schema:

    {
        optional "capture_enabled": bool, // updating this value determines whether capture should be started or stopped.
        optional "session_name": string,
        optional "analysis_packet_reordering": bool,
        optional "analysis_mode": string, // possible values: flow, deep
        optional "analysis_advanced_tcp_enabled": bool,
        optional "analysis_advanced_dns_enabled": bool,
        optional "analysis_advanced_http_enabled": bool,
        optional "analysis_advanced_rtp_enabled": bool,
        optional "vlan_mpls_tag_correlation": bool,
        optional "flow_sampling_interval_s": positive_integer,
    }

  • Response on success (200 OK):

    • same as GET /api/config.

  • Response on validation error or failing to apply the config (400 Bad Request):

    {
        "message_key": string,
        "message": string
        // `fields` for validation errors might be added later.
    }

Back