Skip to main content

BandwidthControlRule Schema

Data structure for Bandwidth Control Rule objects.

Fields​

FieldTypeRequiredDescriptionNotes
access_controlstringNo-API field: access_control
bandwidth_classesEntityReferenceWrapperCollectionNo-API field: bandwidth_classes
default_rulebooleanNo-API field: default_rule
descriptionstringNo--
device_groupsEntityReferenceWrapperCollectionNo-API field: device_groups
device_trust_levelsDeviceTrustLevelsEnumCollectionNo-API field: device_trust_levels
devicesEntityReferenceWrapperCollectionNo--
idintegerYes--
labelsEntityReferenceWrapperCollectionNo--
last_modified_byEntityReferenceNo-API field: last_modified_by
last_modified_timeintegerNo-API field: last_modified_time
location_groupsEntityReferenceWrapperCollectionNo-API field: location_groups
locationsEntityReferenceWrapperCollectionNo--
max_bandwidthintegerNo-API field: max_bandwidth
min_bandwidthintegerNo-API field: min_bandwidth
namestringYes--
orderintegerYes--
protocolsBandwidthControlRuleProtocolsEnumCollectionYes--
rankintegerNo--
statestringNo--
time_windowsEntityReferenceWrapperCollectionNo-API field: time_windows

Example​

{
"access_control": "string",
"bandwidth_classes": [
{
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
],
"default_rule": true,
"description": "string",
"device_groups": [
{
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
],
"device_trust_levels": [
"value"
],
"devices": [
{
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
],
"id": 123
}
// ... more fields