1. Home
  2. Docs
  3. Kiwire ( v3 ) – API
  4. Controller

Controller



Create

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/controller/

Parameters Required

ParameterValueDescription
tenant_idstringTenant ID or Tenant name of the API key
device_typestringDevice type
vendorstringThe vendor of the equipment such as Mikrotik, WifiDog, CMCC and many more.
unique_idstringA unique name or alias for the equipment.
coa_portintegerCOA port
device_ipstringIP Address of the Controller devices
shared_secretstringShared secret key
monitor_methodstring

How is the device being monitored.

  • Ping : Kiwire will use simple ICMP ping to determined if the device is online or offline.
  • Agent: A software agent or compatible agent is installed into the devices. Kiwire will poll the agent or agent will send updates information to Kiwire platform.
communityintegerCommunity string to allow SNMP access to this device.
snmpvstringThe device SNMP version.
mibstringManagement Information Base (MIB) to be use in the SNMP request.



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/controller/{{id}}/

Parameters Required

ParameterValueDescription
tenant_idstringTenant ID or Tenant name of the API key
device_typestringDevice type
vendorstringThe vendor of the equipment such as Mikrotik, WifiDog, CMCC and many more.
unique_idstringA unique name or alias for the equipment.
coa_portintegerCOA port
device_ipstringIP Address of the Controller devices
shared_secretstringShared secret key
monitor_methodstring

How is the device being monitored.

  • Ping : Kiwire will use simple ICMP ping to determined if the device is online or offline.
  • Agent: A software agent or compatible agent is installed into the devices. Kiwire will poll the agent or agent will send updates information to Kiwire platform.
communityintegerCommunity string to allow SNMP access to this device.
snmpvstringThe device SNMP version.
mibstringManagement Information Base (MIB) to be use in the SNMP request.



delete

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/controller/{{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/controller/

[GET] https://{{kiwire_ip}}/api/controller/{{id}}/

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


 ValueDescription
offsetintegerStart data count
limitintegerLimit data count
columnstringColumn name
orderdesc or ascSort the result set in ascending or descending order.

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg :

https://{{kiwire_ip}}/api/controller/0/10/id/desc/