API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read the configured Gateway System Profiles

The Gateway System profile defines device-level operational parameters including timezone configuration, LCD menu controls, system IP addressing (controller-ip), global firewall policies, AAA authentication timers, RADIUS/TACACS+ client settings, IPv6 proxy router advertisements, DNS query intervals, and SNMP location attributes.
This profile relies on VLAN Interface and Loopback Interface configurations for network-facing parameters.
Certain features like datapath energy efficiency, LCD menu, and GPS support are hardware-dependent and available only on specific Gateway models.
Use this API to retrieve the list of Gateway System profiles.

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