Get tunnel availability timeseries data for monitoring tunnel health metrics over time.

get

http://127.0.0.1:8080/stats/timeseries/availability/tunnel

Retrieves tunnel availability timeseries data for a specified appliance and date. Returns downtime metrics including tunnel state, blackout, brownout, and IPSLA failures measured in seconds during business hours. The time range is determined by the appliance's configured timezone and business hours.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

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

date

string

required

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

Date for which to retrieve availability data. For 'month' granularity, use the first day of the month.

overlayId

string

required

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

tunType

string

required

Tunnel type filter. For overlays: 0=SD-WAN, 2=Breakout, 3=Services. For underlays: 1=Underlay, 2=Pass-through, 3=Services.

granularity

string

enum

required

Time granularity for data aggregation. 'day' returns minute-level data, 'week' and 'month' return daily aggregates.

Allowed:

tunnelName

string

Filter by specific tunnel name. Optional parameter to narrow results to a single tunnel.

serviceName

string

Filter by service name. Supports partial matching (prefix search). Optional.

label

string

Filter by tunnel label/tag. Optional parameter for categorized filtering.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response containing tunnel availability timeseries data.

400Bad Request - Invalid or missing nePk parameter.

503Service Unavailable - Unable to connect to the statistics database.