GET /qni/hosts/{host_id}/configs

Retrieves a list of QNI configurations. The list contains a single configuration.

Table 1. GET /qni/hosts/{host_id}/configs resource details
MIME Type
application/json

Table 2. GET /qni/hosts/{host_id}/configs request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
host_id	path	Required	Number (Integer)	text/plain	Long The ID of the QNI host.
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.
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.

Table 3. GET /qni/hosts/{host_id}/configs response codes
HTTP Response Code	Unique Code	Description
200		QNI Configuration has been successfully retrieved.
404	44001	The QNI host ID does not exist.
422	44020	The QNI host ID is less than or equal to 0.
500	44010	An internal server error occurred while processing a request.

Response Description

An array containing a single QNI Configuration object. This is the current configuration of a QNI host.

id - Number - ID of the QNI configuration. Always equals 1 because QNI host has only one configuration.
host_id - Number - ID of the QNI host.
inspection_level - Enumeration - Depth of content inspection. The possible values are:
- BASIC - Lowest level of inspection. Flows are detected by 5-tuple, and the number of bytes and packets that are flowing in each direction are counted.
- ENRICHED - Each flow is identified and inspected by one of the protocol or domain inspectors. The inspection can generate many kinds of attributes.
- ADVANCED - The highest level of inspection. It does everything that the Enriched Flows levels does, but it also scans and inspects the content of the files that it finds.
- DEFAULT - The QNI host uses the globally-set inspection level setting.
raw_payload - Long - The maximum amount of data (bytes) that the QFlow Collector is set to capture and retain in the flow payload. Possible values are:
- -1: The QNI host is set to use the globally-set raw payload setting.
- 0: Turn the payload off.
- 1 - 32768: The number of bytes.
ports - Array - Array of configured network card ports. Each port has the following fields:
- port_id - Number - The ID of the port.
- type - Enumeration - The mode that the port is used in. The possible values are RECEIVE, TRANSMIT. RECEIVE type indicates the port is configured to receive traffic. TRANSMIT type indicates the port is transmitting traffic duplicated from another port.
- source_port_id - Number - The ID of the port the that re-transmits the traffic. Only populated if port type is TRANSMIT.

Response Sample


[
    {
        "host_id": 42,
        "id": 42,
        "inspection_level": "String <one of: BASIC, ADVANCED, ENRICHED, DEFAULT>",
        "ports": [
            {
                "id": 42,
                "source_port_id": 42,
                "type": "String <one of: RECEIVE, TRANSMIT>"
            }
        ],
        "raw_payload": 42
    }
]