HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/interfaces/{Interface.name}/tunnel_endpoints

Path Params
string
required

Reference Resource: Interface
The interface name. For non-bonded ports, the interface name is the same as the associated port name. The name must otherwise be unique across all ports and interfaces of the system.

Body Params
string
required
length ≤ 45

Reference Resource: Tunnel_Endpoint
Destination tunnel IP address in IPv4 or IPv6 format.

string
required

Reference Resource: Tunnel_Endpoint
Interface that tunnel endpoint is associated with.

network_id
array of strings
required
length between 1 and 9223372036854776000

Reference Resource: Virtual_Network_ID
Network ID (VNI in VXLAN case) that should be used to reach this endpoint.

network_id*
string

Reference Resource: Tunnel_Endpoint
Identifies the mechanism that is responsible for the creation of the endpoint: 'static': user configuration 'evpn': dynamically learnt via EVPN 'hsc': dynamically learnt from a remote controller(e.g.NSX)

string
required

Reference Resource: Tunnel_Endpoint
VRF to be used for resolving the destination address.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!