HomeGuidesAPI Reference
API Reference

Export underlay (physical) tunnel topology as CSV

Exports physical tunnel topology information for specified appliance nePks as a downloadable CSV file. Physical (underlay) tunnels are point-to-point connections over WAN interfaces that form the foundation for overlay (bonded) tunnels. The CSV includes source/destination appliance details (hostname, site, nePk), HA peer mappings, WAN interface information (name, label, IP, HA status), tunnel identifiers (tunnelId-A, tunnelId-Z), tunnel alias names, administrative state, tunnel mode, and the overlay tunnel IDs that this physical tunnel supports (supportedTunnel). Fields tunnelSubType and tunnelSubTypeId are 'n/a' for underlay tunnels as these apply only to overlay and passthrough types.

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

JSON object containing the nePks array. The nePks field is required. Pass an empty array to export underlay topology for all appliances.

nePks
array of strings
required

Set of appliance network element primary keys to export underlay topology for. Pass empty array to export all appliances.

nePks*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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