GET /bandwidth_manager/configurations/{id}

Retrieves a configuration.

Table 1. GET /bandwidth_manager/configurations/{id} resource details
MIME Type
application/json

Table 2. GET /bandwidth_manager/configurations/{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/configurations/{id} response codes
HTTP Response Code	Unique Code	Description
200		The configuration was retrieved.
404	1002	The configuration does not exist.
500	1020	An error occurred during the attempt to retrieve the configuration.

Response Description

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


{
    "created_by": "String",
    "device_name": "String",
    "host_id": 42,
    "hostname": "String",
    "id": 42,
    "kb_limit": 42,
    "name": "String"
}