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

Get tunnel availability aggregate stats for a single appliance

get
http://127.0.0.1:8080/stats/aggregate/availability/tunnel

Retrieves aggregated tunnel availability statistics for a single appliance. Data is grouped by overlayId and includes metrics like blackout, brownout, and IPSLA durations. Requires appliance version 9.3.4, 9.4.2, or 9.5.0 or higher for full support.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string
required
^\d{4}-\d{2}-\d{2}$

Date for statistics retrieval. Format: YYYY-MM-DD. For month granularity, use first day of month (e.g., '2022-12-01').

string
enum
required
Defaults to day

Time granularity for data aggregation. Use 'day' for daily stats, 'week' for weekly stats, or 'month' for monthly stats.

Allowed:
string
required

Overlay filter for tunnel types. Use '0' for all physical/underlay tunnels, 'all' for all bonded/overlay tunnels, or a specific overlay ID for a particular overlay.

Responses

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?