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

Retrieve interface labels

get
http://127.0.0.1:8080/gms/interfaceLabels

Returns interface labels configured on Orchestrator. Labels classify network interfaces (WAN/LAN) for overlay tunnel building and traffic policies. Supports ETag-based caching.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter labels by interface type. When specified, returns only labels for that type. If omitted, returns all labels.

Allowed:
boolean

Filter labels by active status. When true, returns only active labels; when false, returns only inactive (soft-deleted) labels. If omitted, returns all labels.

Responses

304

Not Modified. Returned when active=true and ETag matches. Use cached response.

Updated about 13 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 13 hours ago

Did this page help you?