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

Get network role availability aggregate stats

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

Retrieves network role availability aggregate statistics for appliances in the network. Statistics are aggregated by overlay ID, tunnel type, label (network role), and service name. Requires appliance version 9.5.0, 9.4.2, 9.3.4 or higher for full functionality.

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

Data granularity filter. Use 'day' for daily stats, 'week' for weekly aggregation, or 'month' for monthly stats.

Allowed:
string
required
^\d+\.NE$

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

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

Date in YYYY-MM-DD format. For 'month' granularity, use the first day of the month (e.g., 2024-01-01).

string
required

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

boolean
Defaults to false

When true, groups statistics by appliance (nePk). When false, filters stats for the specified nePk only. Default is false.

Responses

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ or READ_WRITE role.

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?