API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read list of Ethernet Interface configurations

Ethernet interfaces provide physical connectivity for network devices including switches, gateways, access points, and bridges. This module supports configuration of interface properties, port profiles, link aggregation, Power over Ethernet (PoE), security features (AAA, port-security, LLDP), Layer 3 routing capabilities, and advanced features like PIM multicast, flow telemetry, and port monitoring. Supported scopes: Device. This configuration relies on Port Profile configurations (sw-profile for switches, gw-profile for gateways, ap-profile for access points, br-profile for bridges) for template-based settings. Interface names follow device-specific patterns (e.g., gateway model GW_7005 supports 0/0/[0-3], GW_7205 supports 0/0/[0-5]). Use this API to retrieve the list of Ethernet Interface configurations.

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