Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /bandwidth_manager/configurations

Retrieves a list of configurations.

Retrieves a list of configurations

Table 1: GET /bandwidth_manager/configurations Resource Details

MIME Type

application/json

Table 2: GET /bandwidth_manager/configurations Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

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.

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.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.

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 /bandwidth_manager/configurations Response Codes

HTTP Response Code

Unique Code

Description

200

 

The configurations were retrieved.

422

1010

A filter parameter is not valid.

422

1030

A sort parameter is not valid.

500

1020

An error occurred during the attempt to retrieve the configurations.

Response Description

An array of configuration objects. A configuration object contains the following fields:

  • Id - Long - The ID that is automatically generated for the configuration. The ID is unique for each configuration that is created.

  • name - String - The name of the configuration.

  • host_id - Long - The ID of the managed host for the configuration. If the ID is null, the configuration applies to all hosts in the deployment.

  • device_name - String - The network device for the configuration.If the name is null, the configuration applies to all devices.

  • kb_limit - Long - The bandwidth limit for the configuration in kilobytes/sec.

  • created_by - String - The created_by field is automatically populated with USER, QRADAR-SAF, QRADAR-SF or QRADAR-AQS-PRIO.

Response Sample