HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. overlayManagerProperties

Update overlay manager properties

post
http://127.0.0.1:8080/overlayManagerProperties

Updates overlay orchestration properties including tunnel settings, polling intervals, and IPsec configuration. Requires READ_WRITE role. After update, all appliances are queued for orchestration. When overwriteExistingTunnels is true, tunnel settings per WAN label are validated unless isOrchestratorSetting=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Skip tunnel settings validation when true. Use for orchestrator-only settings (polling, enable flags).

Body Params

Overlay manager properties to update. Omit ipsecPresharedKey to retain current value.

Request body for updating overlay manager properties.

integer
required
0 to 65535

Auto flow reclassify value applied to all appliances. Range: 0-65535.

boolean
required

Enable or disable overlay orchestration. When false, overlay work is paused.

boolean

Auto-save configuration changes on appliances after each orchestration loop.

boolean

Automatically apply templates to appliances during each orchestration loop.

boolean
Defaults to true

Enable IP SLA rule orchestration with overlay changes.

string

IPsec pre-shared key for tunnel authentication. Omit to retain current value; empty string is invalid.

integer
required
≥ 60

Orchestration polling interval in seconds. Minimum value is 60.

boolean
required

Reset all flows on appliances when orchestration changes are applied.

boolean
Defaults to false

Enable tunnel settings per WAN label. When true, settings map is used for label-specific configuration.

settings
object

WAN label-specific tunnel settings. Keys are WAN label IDs.

string
enum
required

Global tunnel mode for overlay tunnels.

Allowed:
integer
1 to 65535

Global IPsec UDP port for tunnel communication. Must not be a reserved port (4500, 500, 4163).

integer
≥ 1

Port increment value for resolving IPsec UDP port conflicts between same-site appliances.

boolean

Enable inter-region routing. When enabled, hub appliances are promoted in regional overlays.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated about 11 hours ago

Did this page help you?