Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsMxTunnels

deleteOrgMxTunnel

DELETE
/api/v1/orgs/{org_id}/mxtunnels/{mxtunnel_id}

Delete an organization Mist Tunnel configuration by Mist Tunnel ID.

Authorization

Authorization<token>

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

org_id*string
Formatuuid
mxtunnel_id*string
Formatuuid

Response Body

curl -X DELETE "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxtunnels/000000ab-00ab-00ab-00ab-0000000000ab"
Empty

getOrgMxTunnel GET

Retrieve configuration details for a specific organization Mist Tunnel, including cluster, VLAN, heartbeat, IPsec, and preemption settings.

updateOrgMxTunnel PUT

Update an organization Mist Tunnel configuration, including cluster membership, VLANs, heartbeat settings, IPsec, and preemption behavior.