HomeGuidesAPI Reference
API Reference

Get tunnel link status matrix for an overlay network

Returns a symmetric 2D matrix representing tunnel link status between all appliances in the specified overlay. Each cell [i][j] contains the worst-case status between bidirectional tunnels (src→dst and dst→src). If appliance count exceeds APPLIANCE_TOPOLOGY_LINK_THRESHOLD, the linkInfo array is not populated (null). Supports ETag-based caching - provide If-None-Match header with previous ETag to receive 304 if data unchanged.

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

Unique identifier of the overlay network to query. Cannot be null or empty.

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