Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /bandwidth_manager/filters

Creates a bandwidth manager filter

Table 1: POST /bandwidth_manager/filters Resource Details

MIME Type

application/json

Table 2: POST /bandwidth_manager/filters Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

header

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: POST /bandwidth_manager/filters Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

class

Object

application/json

null

{ "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 }

Table 4: POST /bandwidth_manager/filters Response Codes

HTTP Response Code

Unique Code

Description

202

 

The configuration was created successfully.

404

1002

Unable to find the managed host by using the host_id.

422

1005

A parameter was passed incorrectly.

422

1004

The host_id parameter value must be a positive integer or null.

422

1010

null

422

1011

The source_port parameter value must be a positive integer. The value must be in the range 1 - 65534.

422

1012

The source_port_mask parameter value must be a positive integer. The value must be in the range 1 - 65534.

422

1013

The destination_port parameter value must be a positive integer. The value must be in the range 1 - 65534.

422

1014

The destination_port_mask parameter value must be a positive integer. The value must be in the range 1 - 65534.

422

1016

The name parameter value must not exceed 100 characters.

422

1017

The device_name parameter value must not exceed 100 characters.

422

1018

The source_cidr parameter value must be a valid CIDR.

422

1019

The destination_cidr parameter value must be a valid CIDR.

422

1020

The hostname parameter value must not exceed 100 characters.

422

1021

The configuration was not found.

422

1022

The name parameter must not contain the $ character.

500

1030

An error occurred trying to create the filter.

Response Description

Response Sample