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

Create or update AppExpress group configuration

post
http://127.0.0.1:8080/applicationDefinition/appExpressGroup/config

Creates a new AppExpress group or updates an existing one. Validates license limits, group name format, application availability, overlay configuration, QoE intervals, loopback interfaces, and DNS server settings before persisting. Group names are stored in lowercase.

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

AppExpress group configuration object with QoE settings, transport paths, and monitored applications.

Configuration for an AppExpress group defining QoE targets, transport paths, DNS settings, and monitored applications. Requires valid AppExpress license.

string
required
length ≤ 64
^[a-zA-Z0-9._-]+$

Unique group name (alphanumeric, hyphen, underscore, dot only). Stored as lowercase.

boolean
Defaults to false

Enables or disables this AppExpress group for application-aware routing.

string
enum
Defaults to EXCELLENT

Target QoE threshold for routing decisions. Traffic switches paths when QoE drops below target.

Allowed:
integer
≥ 0

Overlay network ID. Must be a valid configured overlay.

eligibleTransportPaths
array of strings

Transport paths eligible for AppExpress routing. Must be valid configured paths.

eligibleTransportPaths
integer
enum
Defaults to 5

User QoE calculation interval in minutes. Must be less than pingQoEUpdateInterval.

Allowed:
integer
enum
Defaults to 10

Ping QoE calculation interval in minutes. Must be greater than userQoEUpdateInterval.

Allowed:
integer
enum
Defaults to 30

Interval in seconds between synthetic probe pings for path monitoring.

Allowed:
sourceLoopbacks
array of objects
required
length ≥ 1

Loopback interfaces for probe sources. At least one required.

sourceLoopbacks*

Configuration for a source loopback interface used in AppExpress probing.

string

Orchestrated label name of the loopback interface used as the probe source.

string

Name of the network segment associated with this loopback interface.

boolean
Defaults to false

Use system DNS instead of custom dnsServers list.

dnsServers
array of strings
length ≤ 3

Custom DNS servers for hostname resolution. Ignored if useSystemDnsServer is true.

dnsServers
integer
≥ 1
Defaults to 1000

DNS query timeout in milliseconds.

integer
≥ 0
Defaults to 3

Number of DNS retry attempts before failure.

appExpressApps
array of strings, unique
required
length ≥ 1

AppExpress-enabled applications to monitor. At least one required. No duplicates allowed.

appExpressApps*
Responses

401

Unauthorized - User does not have READ_WRITE role permissions.

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?