API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new app bandwidth contract profile by unique name

List of App Bandwidth Contract profiles. Each profile is identified by a
unique name and groups up to four types of directional bandwidth contracts:
DPI application (app), DPI application category (app-category), WebCC
reputation score (web-reputation), and WebCC category (web-category).
The combined total number of entries across all four contract lists within
a single profile must not exceed 32.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

App bandwidth Contract profile name.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilesbody object

app
array of objects
length ≤ 2147483647

List of bandwidth contracts keyed by DPI application name and traffic direction.
Each entry maps a specific application (e.g. facebook, youtube, zoom) to a
bandwidth contract for either upstream or downstream traffic. The application
name must be a valid DPI application type and the direction must be specified.
Bandwidth limits are configured via the bwc-units and bit-rate leaves.

app
app-category
array of objects
length ≤ 2147483647

List of bandwidth contracts keyed by DPI application category and traffic direction.
Each entry maps a broad application category (e.g. STREAMING, GAMING,
SOCIAL-NETWORKING) to a bandwidth contract for either upstream or downstream
traffic. This allows bandwidth policies to be applied at the category level
rather than per individual application. Bandwidth limits are configured via
the bwc-units and bit-rate leaves.

app-category
string
length between 1 and 256

App Bandwidth Contract profile description.

string
length between 1 and 256

App bandwidth Contract profile name.

web-category
array of objects
length ≤ 2147483647

List of bandwidth contracts keyed by WebCC category and traffic direction.
WebCC classifies web destinations into categories (e.g. BUSINESS-ECONOMY,
GAMES, EDUCATIONAL-INSTITUTIONS, SOCIAL-NETWORKING). Each entry maps one
WebCC category to a bandwidth contract for either upstream or downstream
traffic, enabling bandwidth policies based on the type of web content being
accessed. There can be at most one contract per category per direction.

web-category
web-reputation
array of objects
length ≤ 2147483647

List of bandwidth contracts keyed by WebCC reputation score range and traffic
direction. WebCC assigns a reputation score to each URL upon classification and
groups scores into the following risk levels: TRUSTWORTHY (81-100),
LOW_RISK (61-80), MODERATE_RISK (41-60), SUSPICIOUS (21-40), and
HIGH_RISK (1-20). Each entry maps one risk level to a bandwidth contract for
either upstream or downstream traffic, allowing differentiated bandwidth
treatment based on the trustworthiness of web destinations. There can be at
most one contract per risk level per direction.

web-reputation
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json