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

Get latency health summary for an appliance at a specific time

get
http://127.0.0.1:8080/health/latencyPeriodSummary

Retrieves latency metrics summary for a specific appliance at a given hour boundary. Returns the tunnel with worst latency performance, including minutes spent in each health state and maximum latency value. Data is aggregated from tunnel health statistics.

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

Hour boundary timestamp in seconds since EPOCH (Unix timestamp). Defines which hourly period to retrieve latency data for.

string
required

Unique identifier of the appliance (network element primary key). Cannot be empty.

int32
required

Overlay network identifier to filter results. Use -1 to include all overlays (excludes underlay with overlayId=0).

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User does not have READ or READ_WRITE permission

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?