Kiwire 3.0 API Documentation - Zone

top of page

Kiwire 3.0 Administrator - Device & Controller Setup Guide

Kiwire 3.0 Administrator - Device & Controller Setup Guide

Cambium Networks Configuration for Kiwire Hotspot

Cambium Networks Configuration for Kiwire Hotspot

Prerequisites

Before integrating the controller with Kiwire, it is necessary that the controller and access point:

are connected to the Internet
are reachable on the network
have an IP address assigned to the a through DHCP or static

Note:

Kiwire-hostname or Kiwire-ip can be obtain by contacting our technical support for our cloud customer. For enterprise client the ip will be on premises Kiwire ip address.
Social network hostname list can be obtained from Social network whitelist guide

Part 1: Cambium cnMaestro configuration

Login to your Cambium cnMaestro controller

Go to WLANs > Configuration > AAA Servers
1. Authentication Server
  1. Host: Kiwire-hostname or Kiwire-Ip
  2. Secret: create a secret pass phrase
  3. Port: 1812
  4. Timeout: 3 seconds
  5. Attempts: 1
2. Accounting Server
  1. Host: Kiwire-hostname or Kiwire-ip
  2. Secret: secret same as authentication server
  3. Port: 1813
  4. Timeout: 3 seconds
  5. Attempts: 1
  6. Accounting Mode: Start-Interim-Stop
  7. Accounting Packet: ticked
  8. Interim Update Interval: 1800 seconds
3. Advanced Settings
  1. NAS-Identifier: AP MAC address with capital letters and colon
  2. Dynamic Authorization: ticked
  3. Dynamic VLAN: ticked
  4. Called Station ID: AP-MAC:SSID

Omaya 3.0 Administrator > Quick Setup > Dashboard

Documentation

Kiwire 3.0 API Documentation > Zone

Articles in this section

Zone Restriction

Kiwire 3.0 API Documentation - Zone

CREATE

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/zone/ Parameters Required

API 31.png

PATCH

Use PATCH method is to make a partial update on a resource.

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

Example request URIs

[PATCH] https://{{kiwire_ip}}/api/zone/{{id}}/ Parameters Required

API 32.png

DELETE

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/zone/{{id}}/

GET

Use GET method to retrieve resource information only and not to modify it in any way.

Example request URIs

[GET] https://{{kiwire_ip}}/api/zone/ [GET] https://{{kiwire_ip}}/api/zone/{{id}}/ [GET] https://{{kiwire_ip}}/api/zone/{{offset}}/{{limit}}/{{column}}/{{order}}/

API 33.png

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg : https://{{kiwire_ip}}/api/zone/0/10/id/desc/

bottom of page