GET /bandwidth_manager/filters/{id}

Retrieves a filter.

Retrieves a filter.

Table 1. GET /bandwidth_manager/filters/{id} resource details
MIME Type

application/json

Table 2. GET /bandwidth_manager/filters/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

id

path

Required

Number (Integer)

text/plain

null

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.
Table 3. GET /bandwidth_manager/filters/{id} response codes
HTTP Response Code Unique Code Description

200

The filter was retrieved.

404

1000

The filter does not exist.

500

1020

An error occurred during the attempt to retrieve the filter.

Response Description

The filter after it is retrieved. 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


{
    "configuration_id": 42,
    "created_by": "String",
    "destination_cidr": "String",
    "destination_port": 42,
    "destination_port_mask": 42,
    "device_name": "String",
    "host_id": 42,
    "hostname": "String",
    "id": 42,
    "match_all": true,
    "name": "String",
    "partner_id": 42,
    "source_cidr": "String",
    "source_port": 42,
    "source_port_mask": 42
}