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

Save interface labels

post
http://127.0.0.1:8080/gms/interfaceLabels

Replaces all interface labels (WAN/LAN) with the provided configuration. Labels classify network interfaces for overlay tunnel building and traffic policies. Requires READ_WRITE permission.

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

Auto-remove inactive labels from dependent configurations. When false (default), fails if inactive labels are referenced elsewhere.

Body Params

Complete interface labels configuration. Overwrites all existing labels.

Container for WAN and LAN interface label mappings.

wan
object

Map of WAN interface labels keyed by label ID.

lan
object

Map of LAN interface labels keyed by label ID.

Responses
204

Labels saved successfully. Appliances queued for orchestration and Overlay Manager notified.

Updated about 14 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:
application/json

Updated about 14 hours ago

Did this page help you?