API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing Interface Profile Configuration for given name.

Interface Profile configuration. It is a bundle of interface configuration
for devices with specific sku/model. Defined for set of uplink/downlink ports, or can
be for custom set of ports for given models. Interface Profile can be defined for stacks/chassis for
fixed/automatic set of members/LineCards. Interface Profile can be defined for custom stack/chassis size.
One Interface Profile can have port-profile config for uplink + downlink + custom ports for given
model/device type. In case of stacks, Interface Profile will not be applied VSF link ports, if they
are part of automatic/custom Interface Profile model+ports.

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

Interface Profile name.

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