HomeGuidesAPI Reference
API Reference

Get inbound shaper settings for an appliance

Retrieves inbound traffic shaper (bandwidth limiter) configuration for all interfaces on the specified appliance. Returns an object where each key is an interface name (e.g., 'wan0', 'wan1') and each value contains the shaper settings including traffic class priority, accuracy level, maximum bandwidth limit, and enabled state. Use cached=true for faster response times or cached=false for real-time data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string
enum
Defaults to true

Source of data retrieval. When true (default), returns cached data from Orchestrator. When false, fetches live data directly from the appliance.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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