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

Update IPSLA Rule Destination for a Service Provider

post
http://127.0.0.1:8080/thirdPartyServices/serviceOrchestration/ipslaRuleDestination

Saves or updates the IP SLA (Service Level Agreement) Rule Destination configuration for a specific third-party service provider. This configures monitoring probes used to verify tunnel connectivity and path quality. Changes trigger orchestration updates across all associated appliances. The destination addresses are automatically trimmed and validated.

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

Unique identifier of the third-party service provider to update. Must reference an existing service provider configuration.

Body Params

IPSLA Rule Destination configuration to apply. The destination field is required and cannot be empty. Destination values are automatically trimmed of whitespace.

Configuration for IP SLA monitoring probes used to verify third-party tunnel connectivity. Extends base IPSLA settings with source interface specification. The destination field is required for POST operations.

string

Source interface label for IPSLA probes. Must match a configured WAN interface label.

string
enum
Defaults to ip-monitor

Monitor type for health probes. 'ip-monitor' uses ICMP ping; 'http-monitor' uses HTTP GET requests (requires appliance 9.0.3+).

Allowed:
string
required

Required. Comma-separated list of probe destination addresses. Values are trimmed automatically. For ip-monitor: IP addresses (e.g., '8.8.8.8,8.8.4.4'). For http-monitor: URLs (e.g., 'http://www.example.com/test'). Cannot be empty.

string

HTTP proxy server address for http-monitor type. Only applicable when type is 'http-monitor'.

integer
1 to 65535

HTTP proxy server port. Only used when proxyAddress is specified.

string

Custom User-Agent header for HTTP probes. Only applicable for 'http-monitor' type.

integer
≥ 1

Timeout in seconds for HTTP probe requests. Only applicable for 'http-monitor' type.

integer
≥ 1
Defaults to 1

Polling frequency in seconds for sending probe packets.

integer
≥ 1
Defaults to 3

Consecutive successful probes needed to transition from DOWN to UP.

integer
≥ 1
Defaults to 30

Consecutive failed probes needed to transition from UP to DOWN.

integer
≥ 1
Defaults to 30

Statistics reporting interval in seconds for loss/latency metrics.

integer
≥ 1

Rolling average window size in seconds for loss/latency statistics. Used with quality metrics.

integer
0 to 100

Max acceptable packet loss percentage for UP state. Triggers DOWN if exceeded (based on metricCombination).

integer
0 to 100

Packet loss percentage threshold indicating DOWN state.

integer
≥ 0

Max acceptable latency in milliseconds for UP state. Triggers DOWN if exceeded (based on metricCombination).

integer
≥ 0

Latency threshold in milliseconds indicating DOWN state.

string
enum

Logical operator for loss/latency thresholds. 'or': transition if either exceeds; 'and': both must exceed.

Allowed:
integer
≥ 0
Defaults to 0

Route label identifier. 0 means no label; other values reference configured route labels.

Responses
204

IPSLA Rule Destination configuration updated successfully. No content returned. Changes will be applied to all associated appliances during the next orchestration cycle.

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?