Modify or add a single tunnel by id (name)

post

http://localhost:3001/rest/json/tunnels/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Tunnel name

Body Params

JSON object containing settings for a single tunnel

admin

string

Admin state of the tunnel - takes two values: 'up' or 'down'.

auto_mtu

boolean

Determines if the tunnel should have auto MTU detection.

ctrl_pkt

object

destination

string

Destination IP address.

gre_proto

integer

GRE protocol in the GRE header

ipsec

object

ipsec_arc_window

string

IPSec ARC Window - not configurable.

ipsec_enable

boolean

A quick shortcut for knowing if tunnel mode is IPSec. You can get the same information using mode property.

local_vrf

integer

Routing segmentation segment ID

max_bw

integer

If the tunnel max bandwidth is manually configured, use this field and set max_bw_auto to false. Units Kbps.

max_bw_auto

boolean

If the tunnel max bandwidth needs to be set to auto, this field must be true.

min_bw

integer

Tunnel minimum bandwidth

mode

string

Tunnel mode: it can be one of 'gre', 'udp', 'ipsec'

mtu

integer

Tunnel MTU. If 'auto_mtu' is false, user must set a specific tunnel mtu value

options

integer

Not used. Do not send in POST message

pkt

object

source

string

Source IP address of the tunnel.

threshold

object

type

string

Not used. Do not send in POST message.

udp_dest_port

integer

If the tunnel is of type 'udp', the udp port to use.

udp_flows

integer

If tunnel mode is udp, this field determines how many different udp flows are used to distribute tunnel traffic

Response

200

No response

Language

Loading…

Response

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