Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsWxRules

listOrgWxRules

GET
/api/v1/orgs/{org_id}/wxrules

Get List of Org WxRules

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

Query Parameters

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/wxrules"
[  {    "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-bfeb-53ebbbba6f08",    "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"    ]  }]

updateOrgWlanPortalTemplate PUT

Update a Portal Template #### Sponsor Email Template Sponsor Email Template supports following template variables: | **Name** | **Description** | | --- | --- | | approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized | | deny_url | Renders URL to reject the request | | guest_email | Renders Email ID of the guest | | guest_name | Renders Name of the guest | | field1 | Renders value of the Custom Field 1 | | field2 | Renders value of the Custom Field 2 | | company | Renders value of the Company field | | sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) | | auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |

createOrgWxRule POST

Create Org WxRule