HomeGuidesAPI Reference
API Reference

Get sparse tunnel link status pairs for an overlay network (v2)

Returns tunnel link status as sparse array-of-pairs grouped by status, replacing the dense N×N matrix from v1. The response contains linkInfo[status] = [[srcIndex, destIndex], ...] where each [srcIndex, destIndex] pair references indices into the nePks array. Status codes: 0=NO_TUNNEL, 1=UP, 2=PARTIALLY_DOWN, 3=DOWN, 4=NO_STATUS. Payload size is O(T) where T is the number of tunnel connections, compared to O(N²) in v1. No appliance count threshold — works at any scale. Supports ETag-based caching.

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

Overlay network identifier. Use 'all' for worst-case status across all overlays, '0' for underlays, or a specific overlay ID (e.g. '1', '2').

Headers
string

ETag value from previous response for conditional caching. If provided and cache is valid, returns 304.

Responses

304

Not Modified - Cached response is still valid. Returned when If-None-Match header matches current ETag.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json