API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing app bandwidth contracts

App Bandwidth Contracts. This container holds named profiles that define
directional (UPSTREAM/DOWNSTREAM) bandwidth limits for application traffic.
Each profile can include four different contract types: DPI application based
contracts (app), DPI application category based contracts (app-category), WebCC
reputation score/risk based contracts (web-reputation), and WebCC category based
contracts (web-category). Each contract entry uses a composite key leaf that
combines the identifier and direction. Bandwidth limits are configured by
selecting bandwidth units (kbits/s or mbits/s) and specifying a bit-rate; the
bit-rate is validated by a YANG must constraint with unit-specific ranges
(256..2000000 for KBITS_PER_SEC and 1..2000 for MBITS_PER_SEC).
The combined total number of entries across all four contract lists (app,
app-category, web-reputation, and web-category) within a single profile
must not exceed 32.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

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