API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Modify Spanning Tree profile

Spanning Tree profile defining RSTP or RPVST configuration
with global bridge parameters and per-VLAN settings. Each
entity is identified by profile name. Use these APIs to
create, modify, or delete a Spanning Tree profile.

Path Params
string
required
length ≤ 9999

STP profile name.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

string
length between 1 and 256

STP profile description.

boolean
Defaults to true

Enable and Disable Spanning Tree at system level.

int32
4 to 30
Defaults to 15

Device waits between transitioning from listening to learning
and from learning to forwarding states.

int32
1 to 10
Defaults to 2

Time between messages transmission when the switch is root.

int32
6 to 40
Defaults to 20

Maximum age of received STP information before it is discarded.

string
enum

Spanning Tree mode to enable RSTP or RPVST. Gateways support RSTP and RPVST

Show Details
MSTPMultiple spanning tree mode.
RPVSTRapid per VLAN spanning tree mode.
RSTPRapid spanning tree mode.
Allowed:
string
length between 1 and 256

STP profile name.

int32
0 to 65535
Defaults to 32768

STP device priority.

rpvst
array of objects
length ≤ 2147483647

Per-VLAN Rapid Spanning Tree (RPVST) instance configuration
allowing independent STP parameters for each VLAN. Each entity is
identified by VLAN ID. Configure VLAN-specific bridge priority,
forward-delay, hello-time, and max-age timers.

rpvst
Responses

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