Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /config/flow/common_destination_ports/active_configurations/{id}

SUMMARY Gets the active configuration for a common destination port, as specified by an ID.

Gets the active configuration for a common destination port, as specified by an ID. You must have System Administrator or Security Admin permissions to use this endpoint.

Table 1: GET /config/flow/common_destination_ports/active_configurations/{id} resource details:

GET /config/flow/common_destination_ports/active_configurations/{id} resource details

MIME Type

application/json

Table 2: GET /config/flow/common_destination_ports/active_configurations/{id} request parameter details:

GET /config/flow/common_destination_ports/active_configurations/{id} request parameter details

Parameter Type Optionality Data Type MIME Type Description

id

path

Required

Number (Integer)

text/plain

The ID of the active configuration to get.
Table 3: GET /config/flow/common_destination_ports/active_configurations/{id} response codes:

GET /config/flow/common_destination_ports/active_configurations/{id} response codes

HTTP Response Code Unique Code Description

200

The active Common Destination Port Configuration for the specified port number.

404

2001

A active configuration for the specified ID does not exist.

422

1005

A field request parameter is not valid.

422

1010

Invalid filter criteria supplied.

422

1015

The sort field or order is not valid.

500

1020

An error occurred while retiriving active Common Destination Port Configuration.

Response Description

The active Common Destination Port Configuration for the specified ID. An active Common Destination Port Configuration object contains the following fields:
  • id - Long - The unique ID of the configuration.
  • port - Integer - The unique port number that you want to configure.
  • application_id - Long - The application ID for this port configuration. The application ID for this port configuration that is used by the JSA port-based mapping algorithm.
  • application_name - String - The name of the application as it would appear on the Network Activity tab.
  • content_capture_size - Integer - The maximum amount of payload to capture and store for an application on this port. Set this value to 1 if you want the application to inherit the content capture size from the SV_CONTENT_CAPTURE_LENGTH field in the nva.conf file.
  • app_detection_enabled - Boolean - TRUE if the port configuration will be used to determine the application. If true, you must set the application_id.
  • flow_direction_enabled - Boolean - TRUE if the port configuration will be used to determine the flow direction.
  • uuid - String - The unique global ID of the configuration, specified as a UUID.
  • last_update_time - Long - The epoch timestamp, represented in milliseconds, since this configuration was last modified.

Response Sample