Overview
The shaping API allows you to get and set various bandwidth values on preconfigured bridges and virtual bridges. This allows 3rd party system to make programatic adjustment to shaping parameters.
Methods
List Bridges
Get a list of bridges configured for shaping on a particular probe.
GET /api/v2/probes/<uuid>/shaping/bridges.json
This will return an array of 'bridge' objects:
[
{
bridge: <name>,
bandwidthIn: <num>,
bandwidthOut: <num>,
virtual_bridges: [<virtual_bridge_uuids]
}
]
List a Bridge
Get details of a single bridge configured for shaping on a particular probe.
GET /api/v2/probes/<uuid>/shaping/bridges/<br_name>.json
This will return a single 'bridge' object:
{
bridge: <name>,
bandwidthIn: <num>,
bandwidthOut: <num>,
virtual_bridges: [<virtual_bridge_uuids]
}
Edit a Bridge
Set bandwidth values on a bridge configured for shaping on a particular probe.
POST /api/v2/probes/<uuid>/shaping/bridges/<br_name>.json
You can set any or all of these fields in the 'bridge' object.
{
bandwidthIn: <num>,
bandwidthOut: <num>
}
List Virtual Bridges
Get a list of virtual bridges configured for a particular bridge.
GET /api/v2/probes/<uuid>/shaping/bridges/<br_name>/virtual-bridges.json
This will return an array of 'virtual bridge' objects:
[
{
label: <name>,
maxBandwidthIn: <num>,
maxBandwidthOut: <num>,
minBandwidthIn: <num>,
minBandwidthOut: <num>,
manualInternet: <boolean>,
maxInternetBandwidthIn: <num>,
maxInternetBandwidthOut: <num>,
minInternetBandwidthIn: <num>,
minInternetBandwidthOut: <num>
}
]
List a Virtual Bridge
Get details of a single virtual bridge configured for a particular bridge.
GET /api/v2/probes/<uuid>/shaping/bridges/<br_name>/virtual-bridges/<virtual_bridge_uuid>.json
This will return a single 'virtual bridge' object:
{
label: <name>,
maxBandwidthIn: <num>,
maxBandwidthOut: <num>,
minBandwidthIn: <num>,
minBandwidthOut: <num>,
manualInternet: <boolean>,
maxInternetBandwidthIn: <num>,
maxInternetBandwidthOut: <num>,
minInternetBandwidthIn: <num>,
minInternetBandwidthOut: <num>
}
Edit a Virtual Bridge
Set bandwidth values on a virtual bridge configured for a particular bridge.
POST /api/v2/probes/<uuid>/shaping/bridges/<br_name>/virtual-bridges/<virtual_bridge_uuid>.json
You can set any or all of these fields in the 'virtual bridge' object.
{
label: <name>,
maxBandwidthIn: <num>,
maxBandwidthOut: <num>,
minBandwidthIn: <num>,
minBandwidthOut: <num>,
manualInternet: <boolean>,
maxInternetBandwidthIn: <num>,
maxInternetBandwidthOut: <num>,
minInternetBandwidthIn: <num>,
minInternetBandwidthOut: <num>
}
Comments
0 comments
Article is closed for comments.