Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /bandwidth_manager/filters

SUMMARY Retrieves a list of egress filters.

Retrieves a list of egress filters

Table 1: GET /bandwidth_manager/filters resource details:

GET /bandwidth_manager/filters resource details
MIME Type

application/json

Table 2: GET /bandwidth_manager/filters request parameter details:

GET /bandwidth_manager/filters request parameter details
Parameter Type Optionality Data Type MIME Type Description

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.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.
Table 3: GET /bandwidth_manager/filters response codes:

GET /bandwidth_manager/filters response codes
HTTP Response Code Unique Code Description

200

The rules were retrieved.

422

1010

A request parameter is not valid.

422

1030

A sort parameter is not valid.

500

1020

An error occurred during the attempt to retrieve the filters.

Response Description

An array of filter objects. A filter object contains the following fields:
  • id - Long - The ID that is automatically generated for the filter. The ID is unique for each filter that is created.
  • name - String - The name of the filter that is supplied by the user.
  • host_id - Long - The ID of the managed host for the filter. If the ID is null, the filter applies to all hosts in the deployment.
  • device_name - String - The network device for the filter. If the name is null, the filter applies to all devices.
  • source_port - Integer - The source port for the filter.
  • source_port_mask - Integer - The source port mask for the filter.
  • source_cidr - String - The source CIDR for the filter.
  • destination_port - Integer - The destination port for the filter.
  • destination_port_mask - Integer - The destination port mask for the filter.
  • destination_cidr - String - The destination CIDR for the filter.
  • match_all - Boolean - Indicates whether the filter matches all incoming packets by priority level. The default is false, and can be set to true.
  • created_by - String - The created_by field is automatically populated with USER, QRADAR-SAF, QRADAR-SF or QRADAR-AQS-PRIO.

Response Sample