/overlays3/config/{overlayId}

post

http://localhost:3001/rest/json/overlays3/config/{overlayId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

overlayId

string

required

Query Params

deleteDependencies

boolean

Boolean flag on whether or not to delete dependencies

Body Params

bondingPolicy

number

enum

The number of the bonding policy for the overlay. 1 - high availability, 2 - high quality, 3 - high throughput, 4 - high efficiency, 5 - custom bonding policy

Allowed:

boostTraffic

boolean

Whether or not to boost the traffic of this overlay.

brownoutThresholds

object

Brownout thresholds configuration

disqualifyBehavior

number

enum

Remove link on overlay or underlay brownout, 1 for On Overlay Brownout, 2 for On Underlay Brownout

Allowed:

fecWaitTime

number

FEC wait time in millisecond

internetPolicy

object

Describes what to do with internet traffic if it matches the overlay

linkReorderFrequency

number

enum

Link reorder speed, 1 for Aggressive, 2 for Moderate, 3 for Conservative

Allowed:

match

object

Match configuration

maxFecPercentage

number

Maximum FEC radio in percentage

maxPOCWait

number

Maximum packet reorder wait time in millisecond

minFecPercentage

number

Minimum FEC radio in percentage

minPOCWait

number

Minimum packet reorder wait time in millisecond

name

string

The name of the overlay.

overlayFallbackOption

number

The fallback option of the overlay.

pathLoading

number

The number of the path loading policy for the overlay. 1 - balance by link capacity, 2 - balance by link utilization, 3 - waterfall by quality, 4 - waterfall by latency, 5 - waterfall by loss, 6 - waterfall by jitter, 7 - waterfall by cost, 8 - waterfall by link order

topology

object

Topology configuration for this overlay

trafficClass

string

The shaper traffic class to use in the overlay.

useBackupOnBrownout

boolean

Use the backup WAN ports when the primary WAN ports meet the brownout conditions.

useSecondaryOnBrownout

boolean

Use the secondary WAN ports when the primary WAN ports meet the brownout conditions.

wanLabelMap

object

SD-WAN Links configuration

wanPorts

object

Wan port configuration

zoneId

number

Zone Id for this overlay

Response

200

No response

Language

Loading…

Response

Click Try It! to start a request and see the response here!