createOrgMxTunnel
Create an organization Mist Tunnel configuration, including hosting Mist Edge clusters, VLANs, heartbeat settings, and optional IPsec settings.
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
Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge clusters
IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
Preemption behavior for restoring preferred tunnel peers after failover
In 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 heartbeats before an AP tries another tunnel peer
2 <= value <= 307Security settings for IPsec support on this Mist Tunnel
0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
0 <= value <= 15000Mist Edge cluster IDs that host this Mist Tunnel
Display name of the Mist Tunnel
Encapsulation protocol used for the Mist Tunnel. enum: ip, udp.
"udp"Value in
- "ip"
- "udp"
List of VLAN IDs carried by this Mist Tunnel
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxtunnels" \ -H "Content-Type: application/json" \ -d '{ "cluster_ids": [ "string" ], "hello_interval": 60, "hello_retries": 7, "ipsec": { "dns_servers": [ "string" ], "enabled": true, "extra_routes": [ { "dest": "string", "next_hop": "192.168.0.1" } ], "split_tunnel": true, "use_mxedge": true }, "vlan_ids": [ 0 ] }'{ "cluster_ids": [ "string" ], "created_time": 0, "for_site": true, "hello_interval": 60, "hello_retries": 7, "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "ipsec": { "dns_servers": [ "string" ], "enabled": true, "extra_routes": [ { "dest": "string", "next_hop": "192.168.0.1" } ], "split_tunnel": true, "use_mxedge": true }, "modified_time": 0, "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "vlan_ids": [ 0 ]}