API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Read existing Ethernet Interface instance configuration

get
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/ethernet-interfaces/

Represents a single physical Ethernet or USB interface configuration on the device. Each interface is uniquely identified by its name (e.g., 0/0/1, enet0, usb0). Use these APIs to create, modify, or delete an interface configuration instance.

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

Unique identifier for the Ethernet or USB interface. Supported formats include slot-based naming (e.g., 0/0/1 for slot 0, module 0, port 1) and logical naming (e.g., enet0, usb0). Device models enforce specific port ranges through capability constraints (e.g., gateway model GW_7005 supports 0/0/[0-3], GW_7205 supports 0/0/[0-5]). This field is mandatory and serves as the primary key for the interface instance.

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

Updated 11 days ago

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

Updated 11 days ago