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

Get Inter-Segment DNAT policies from appliance

get
http://127.0.0.1:8080/vrfSegments

Retrieves all Inter-Segment Destination NAT (DNAT) policies configured on a specific appliance. These policies define traffic translation rules for cross-segment (VRF) communication. The endpoint queries either the Orchestrator's cached data or fetches live configuration directly from the appliance based on the 'cached' parameter. Requires READ or READ_WRITE permissions.

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 true

Data retrieval source. When true (default), returns cached data from Orchestrator database. When false, fetches live data directly from the appliance.

Allowed:
Responses

401

Unauthorized. User lacks READ or READ_WRITE permission to access VRF segment data.

Updated about 12 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 12 hours ago

Did this page help you?