Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesWxRules

createSiteWxRule

POST
/api/v1/sites/{site_id}/wxrules

Create Site WxLan Rule

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

site_id*string
Formatuuid

Request Body

application/json

Request Body

WxLAN policy rule controlling traffic between WxLAN tags

action?wxlan_rule_action

Allow or block behavior applied by this WxLAN rule

Value in

  • "allow"
  • "block"
apply_tags?array<string>

WxLAN tag identifiers applied when this rule matches

blocked_apps?array<string>

Application keys always blocked by this rule, regardless of the rule action

dst_allow_wxtags?array<string>

Destination WxLAN tag identifiers explicitly allowed by this rule

dst_deny_wxtags?array<string>

Destination WxLAN tag identifiers explicitly denied by this rule

dst_wxtags?array<string>

Destination WxLAN tag identifiers matched by this rule

enabled?boolean

Whether this WxLAN rule is enabled

Defaulttrue
order*integer

Lookup priority for WxLAN rules; larger positive values match first, and -1 means LAST. Uniqueness is not checked

Range-1 <= value
src_wxtags*array<string>

Source WxLAN tag identifiers that must match for this rule to apply

template_id?string

Only for Org Level WxRule

Formatuuid

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wxrules" \  -H "Content-Type: application/json" \  -d '{    "action": "allow",    "apply_tags": [      "c049dfcd-0c73-5014-1c64-062e9903f1e5"    ],    "blocked_apps": [      "mist",      "all-videos"    ],    "dst_allow_wxtags": [      "fff34466-eec0-3756-6765-381c728a6037",      "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3"    ],    "dst_deny_wxtags": [      "aaa34466-eec0-3756-6765-381c728a6037",      "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3"    ],    "enabled": true,    "order": 1,    "src_wxtags": [      "8bfc2490-d726-3587-038d-cb2e71bd2330",      "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9"    ]  }'
{  "action": "allow",  "apply_tags": [    "c049dfcd-0c73-5014-1c64-062e9903f1e5"  ],  "blocked_apps": [    "mist",    "all-videos"  ],  "created_time": 0,  "dst_allow_wxtags": [    "fff34466-eec0-3756-6765-381c728a6037",    "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3"  ],  "dst_deny_wxtags": [    "aaa34466-eec0-3756-6765-381c728a6037",    "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3"  ],  "enabled": true,  "for_site": true,  "id": "497f6eca-6276-4993-9feb-53cbbbba6f08",  "modified_time": 0,  "order": 1,  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",  "src_wxtags": [    "8bfc2490-d726-3587-038d-cb2e71bd2330",    "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9"  ]}

listSiteWxRules GET

Get List of Site WxLan Rules

getSiteWxRule GET

Get Site WxLan Rule Details