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

Export topology tunnel details as CSV file

get
http://127.0.0.1:8080/gms/topologyConfig/export

Exports tunnel topology information for specified appliance(s) and tunnel type as a downloadable CSV file. The CSV contains source and destination appliance details, interface configurations, tunnel identifiers, HA peer mappings, and administrative states. Use 'all' for nePk to export all appliances.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

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

string
enum
Defaults to all

Type of tunnel to export. Controls which tunnel category is included in the CSV output.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 11 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/vnd.ms-excel
application/json

Updated about 11 hours ago

Did this page help you?