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

Save Netskope IPSLA rule destination

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

Updates the IP SLA monitoring configuration for Netskope tunnel health checks. Validates that type is 'ip-monitor' and destination is empty. Changes are logged to system audit trail.

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

IPSLA rule destination configuration. The 'type' must be 'ip-monitor' and 'destination' must be null/empty (auto-generated from Netskope POP endpoints).

Configuration for Netskope IP SLA (Service Level Agreement) rule destination. Defines monitoring parameters for tunnel health checks to Netskope service edges. Extends the base IpslaRuleDestination with a sourceInterface field specific to Netskope.

string

The WAN interface label used as the source for IPSLA probes. Must match a configured interface label on the appliance. If not specified, may trigger a NETSKOPE_IPSLA_SOURCE_INTERFACE_MISSING alarm.

string
enum
Defaults to ip-monitor

The type of IP SLA monitor. For Netskope integration, only 'ip-monitor' (ICMP ping) is supported. This value is validated on POST and will reject non-ip-monitor types.

Allowed:
string | null

The destination IP address or hostname for IPSLA probes. For Netskope, this field should be left null/empty as the destination is dynamically generated based on Netskope POP (Point of Presence) endpoints.

string | null

HTTP proxy server address for HTTP-based monitoring. Not applicable for Netskope ip-monitor type.

integer | null
1 to 65535

HTTP proxy server port number for HTTP-based monitoring. Not applicable for Netskope ip-monitor type.

string | null

User-Agent header for HTTP-based monitoring. Not applicable for Netskope ip-monitor type.

integer | null

Timeout in seconds for HTTP-based monitoring requests. Not applicable for Netskope ip-monitor type.

integer
≥ 1
Defaults to 1

The polling frequency in seconds between IPSLA probes. Determines how often the appliance sends ICMP ping probes to the Netskope service edge.

integer
≥ 1
Defaults to 3

Number of consecutive successful probes required to mark a tunnel as UP. The tunnel transitions to UP state after this many successful responses.

integer
≥ 1
Defaults to 30

Number of consecutive failed probes required to mark a tunnel as DOWN. The tunnel transitions to DOWN state after this many failed responses.

integer
≥ 1
Defaults to 30

The interval in seconds for the IPSLA rule execution cycle. Controls the overall timing of the monitoring process.

integer | null
≥ 1

The time window in seconds for calculating rolling average metrics for loss and latency. Metrics are averaged over this period for threshold comparisons.

integer | null
0 to 100

Packet loss percentage threshold for marking tunnel as UP. When loss drops below this percentage within the sampling window, the tunnel is considered healthy.

integer | null
0 to 100

Packet loss percentage threshold for marking tunnel as DOWN. When loss exceeds this percentage within the sampling window, the tunnel is considered unhealthy.

integer | null
≥ 0

Latency threshold in milliseconds for marking tunnel as UP. When latency drops below this value within the sampling window, the tunnel is considered healthy.

integer | null
≥ 0

Latency threshold in milliseconds for marking tunnel as DOWN. When latency exceeds this value within the sampling window, the tunnel is considered unhealthy.

string | null
enum

Logical operator for combining loss and latency thresholds. 'OR' means either condition triggers state change, 'AND' means both conditions must be met.

Allowed:
integer
≥ 0
Defaults to 0

The route label ID to associate with this IPSLA rule for traffic routing decisions. Value 0 indicates no specific route label is used (default behavior).

Responses
204

Configuration saved successfully. No content returned. The action is logged for audit purposes.

401

Unauthorized - Requires READ_WRITE permission.

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

Did this page help you?