API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing Spanning Tree profiles for Gateways

Spanning Tree Protocol (STP) prevents network loops and ensures
redundant path management in Layer 2 switched networks per IEEE
802.1D/802.1w standards. This module configures RSTP (Rapid Spanning
Tree Protocol) and RPVST (Rapid Per-VLAN Spanning Tree) for Gateway
devices. Configure global STP parameters including bridge priority,
timers (hello-time, forward-delay, max-age), and per-VLAN RPVST
instances. Use this API to retrieve the list of Spanning Tree
profiles.

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
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json