createOrgWxTunnel
Create Org WxAN Tunnel
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidRequest Body
application/json
Request Body
WxLAN tunnel configuration for L2TPv3 or DMVPN connectivity
Settings for Dynamic Multipoint VPN on this WxLAN tunnel
Determined during creation time and cannot be toggled. A management tunnel cannot be used by wxlan rule or by wlan
falseIn seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by hello_retries.
1 <= value <= 30060Number of missed hello messages before the AP tries another tunnel peer
2 <= value <= 307Optional, overwrite the hostname in SCCRQ control message, default is or null, %H and %M can be used, which will be replace with corresponding values:
- %H: name of the ap if provided (and will be stripped so it can be used for hostname) and fallbacks to MAC
- %M: MAC (e.g. 5c5b350e0060)
Security settings for IPsec on this WxLAN tunnel; requires DMVPN to be enabled
Whether it’s static/unmanaged (i.e. no control session). As the session configurations are not compatible, cannot be toggled.
false0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
0 <= value <= 15000The name of the tunnel
Remote peer IP addresses or hostnames for this tunnel
Optional, overwrite the router-id in SCCRQ control message, default is "" or null, can also be an IPv4 address
Shared secret used for tunnel authentication, ‘’ if no auth is used
L2TPv3 sessions established for this tunnel
UDP port if use_udp==true
Whether to use UDP instead of IP (proto=115, which is default of L2TPv3)
falseResponse Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/wxtunnels" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "created_time": 0, "dmvpn": { "enabled": true, "holding_time": 0, "host_routes": [ "string" ] }, "for_mgmt": true, "hello_interval": 1, "hello_retries": 3, "hostname": "string", "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "ipsec": { "enabled": true, "psk": "string123" }, "is_static": true, "modified_time": 0, "mtu": 1500, "name": "string", "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "peers": [ "string" ], "router_id": "string", "secret": "string", "sessions": [ { "ap_as_session_id": "string", "comment": "string", "enable_cookie": true, "ethertype": "ethernet", "local_session_id": 1, "pseudo_802.1ad_enabled": true, "remote_id": "string", "remote_session_id": 1, "use_ap_as_session_ids": true } ], "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "udp_port": 0, "use_udp": true}