GET /config/flow_sources/flow_source_management/flowSources

Gets the list of flow sources that are available to the current user.

Gets the list of flow sources that are available to the current user. You must have ADMIN or SAASADMIN permissions to use this endpoint.

Table 1. GET /config/flow_sources/flow_source_management/flowSources resource details
MIME Type

application/json

Table 2. GET /config/flow_sources/flow_source_management/flowSources request parameter details
Parameter Type Optionality Data Type MIME Type Description

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3. GET /config/flow_sources/flow_source_management/flowSources response codes
HTTP Response Code Unique Code Description

200

A list of flow sources that are available to the current user.

500

1000

An error occurred while retiriving Flow Sources.

Response Description

A list of Flow Sources. This will list all flow sources available to the logged in user. A Flow Source object contains the following fields:
  • id - Long - The ID of the Flow Source.
  • name - String - The name of the Flow Source.
  • flow_source_type - Enumeration - The Flow Source type. Use one of the following values: NIC, JFLOW, PACKETEER, NETFLOW, SFLOW, NAPATECH
  • is_deployed - Boolean - TRUE if the Flow Source is deployed.
  • is_enabled - Boolean - TRUE if the Flow Source is enabled.
  • is_asymmetrical - Boolean - TRUE if the Flow Source is configured as asymmetrical.
  • flow_source_config - Array - The list of nva.conf configuration parameters that are configured for the Flow Source.
  • target_flow_collector - Object - The flow collector that the Flow Source is targeted to.
  • incoming_qni_connections - Array - The list of QNI hosts that currently target the Flow Source.

Response Sample


[
    {
        "asymmetrical": true,
        "deployed": true,
        "enabled": true,
        "flow_source_config": [
            {
                "id": 42,
                "name": "String",
                "value": "String"
            }
        ],
        "flow_source_type": "String",
        "id": 42,
        "incoming_qni_connections": [
            {
                "hostname": "String",
                "managed_host_id": 42,
                "nat_ip": "String",
                "private_ip": "String"
            }
        ],
        "name": "String",
        "target_flow_collector": {
            "component_name": "String",
            "hostname": "String",
            "managed_host_id": 42
        }
    }
]