Managed Devices

Managed Devices are the Mojo physical devices. These devices can operate as an AP or as a sensor or both AP and sensor (one radio configured as an AP and the other as a sensor), depending on the device model used. They contain a list of physical radios, which in turn contains a list of wireless interfaces (or BSSIDs or virtual access points).

API Calls

/V5/devices/manageddevices

/V5/devices/manageddevices/statistics/traffic

/V5/devices/manageddevices/statistics/groupby

/V5/devices/manageddevices/statistics/trend

/V5/devices/manageddevices/statistics/sorting

/V5/devices/manageddevices/{boxid}/observingmanageddevices

/V5/devices/ssids

/V5/events/manageddevices

/V6/devices/manageddevices

/V5/devices/manageddevices/actions/CHANGE_LOCATION

/V5/devices/manageddevices/actions/CUSTOMIZE_DEVICE_SETTINGS

/V5/devices/manageddevices/actions/GET_SENSOR_DEBUG_LOGS

/V5/devices/manageddevices/actions/REBOOT_SENSORS

V6/devices/manageddevices/{macaddress}

Get Managed Devices

Description Retrieves a paged list of managed devices.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/manageddevices?sortby=<value>&offset=<value>&
limit=<value>&ascending=<value>&filter=<value>
  • offset

    Is used to specify the start index of requested managed devices list. It takes an integer value.
    The default value is 0.

  • limit

    Is used to specify the no of requested managed devices list. It takes an integer value.
    The default value is 100. The maximum value is 1000.

  • sortby

    Is used to sort requested managed devices list by column. The default value is boxid.

  • ascending

    Is used to sort requested managed devices list in a specified order. By default, the sort is descending.
    It takes a boolean value.

  • filter

    Is used to filter the results. Click Filter to view details of how filters need to be specified in the URL.
    For possible names of property attribute, datatypes, applicable values and whether the results can be sorted based on the parameter click Manage Device Filter

  • populateplatformsettings

    A boolean value represents whether to populate platform settings of device or not.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices?
sortby=”name”&filter=%7B%0A%09%09%22property%22%3A%20%22devicemode%22%2C%0A%09%
09%22value%22%3A%20%5B%22AP%22%2C%22SENSOR%22%5D%2C%0A%09%09%22operator%22%3A%20
%22contains%22%0A%20%20%20%20%20%20%20%20%20%20%20%7D%0A&filter=%7B%0A%09%09%22
property%22%3A%20%22model%22%2C%0A%09%09%22value%22%3A%20%5B%22c-75%22%2C%22c-
55%22% 5D%2C%0A%09%09%22operator%22%3A%20%22%3D%22%0A%20%20%20%20%20%20%20%20%
20%20%20%7D%0A
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the managed devices list that match the filter criteria.
The response is in the application/json format.

Get Traffic Statistics for a Managed Device

Description Fetches traffic statistics for a managed device.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/manageddevices/statistics/traffic?boxid=<value>&fromtime=
<value>&totime=<value>&type=<value>&ssid=<value>&frequencyband=<value>
  • boxid

    Is used to specify the client box ID. It takes an integer value. The default value is -1. It is a mandatory field.
    To retrieve the value for boxid refer Managed Device call.

  • fromtime

    Is used to specify the start time in epoch format. It takes an integer value. The default value is -1.

  • totime

    Is used to specify end time in epoch format. It takes an integer value. The default value is – 1.

  • type

    Is used to specify the type of performance trend that is required. It takes a string value.
    Possible values are aptraffic and apdatarate. It is a mandatory field.

  • ssid

    Is used to specify the list of SSIDs for which the results should be returned. It takes a string value.
    To retrieve the value for SSID refer Get SSIDs Configured on a Managed Device call.

  • frequencyband

    Is used to filter the data for the provided frequency band. It takes a string value. Possible values
    are 2.4, 5 and ANY. The default value is ANY.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/statistics
/traffic?type=apdatarate&boxid=1&ssid=test-min-b&frequencyband=2.4
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains traffic statistics for a managed device. The response is
in the application/json format. The content of the response body is listed below.

  • time

    Time in milliseconds. It is an integer value. Sample value, 14803236.

  • fromvalue

    If type=aptraffic, then the number of bytes transferred in KB.
    If type=apdatarate, then uplink data rate in Kbps. It is an integer value. Sample value, 674.

  • tovalue

    If type=aptraffic, then the number of bytes received in KB.
    If type=apdatarate, then downlink data rate in Kbps. It is an integer value.
    Sample value, 532.

  • totalvalue

    The total number of bytes transferred and received, or the total data rate. It is an integer value.
    Sample value, 1206.

  • totalCount

    The number of data points. It is an integer value. Sample value, 45213.

A sample response is as follows:

{
   "samples":[{
      "time": 1480311900,
      "fromvalue": 0,
      "tovalue": 0,
      "totalvalue": 0
   },
      . . .
	  . . .
	  . . .

   {
      "time": 1480323600,
      "fromvalue": 674,
      "tovalue": 532,
      "totalvalue": 1206
   }],
   "totalCount": 45213
}

Get Managed Devices by Group

Description Fetches managed devices that are grouped based on a specified parameter.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/manageddevices/statistics/groupby?groupby=<value>
  • groupby

    Is used to specify the field for the group by. It takes a string value. The applicable values
    are devicename, activestatus, macaddress, ipaddress, capability, model, locationid, timefilter,
    devicetemplate, tag, troubleshooting, quarantinestatus, apmode, upgradestatus,
    configurationstatus, sensortype, meshflag, failsafemode, and powersource.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/statistics
/groupby?groupby=devicename
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains a list of managed devices grouped by a specific field.
The response is in the application/json format. The content of the response body is listed below.

  • group/<groupby value>

    Group by field provided as URL parameter. It is a string value.

  • count

    The total number of devices matching the group by criteria. It is an integer value.

  • totalCount

    The total number of devices across each group. It is an integer value.

A sample response is as follows:

{
   "samples": [{
      "group": {
         "model": "C-60"
      },
      "count": 1
  },
  {
      "group": {
         "model": "C-75"
      },
      "count": 2
  }],
  "totalCount": 3
}

Get Performance Trend for a Managed Device

Description Fetches performance trend for a specified type.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/manageddevices/statistics/trend?devicecategory=<value>
&ssid=<value>&fromtime=<value>&totime=<value>&protocol=<value>&type=<value>
&boxid=<value>&frequencyband=<value>
  • devicecategory

    Is used to specify the category of the managed device. It is a mandatory
    field. Possible values are ROUGE, EXTERNAL, UNCATEGORIZED, AUTHORIZED and MANAGED_AP.

  • ssid

    Is used to specify a list of SSIDs for which the results should be returned. It takes a string
    value. To retrieve the value for SSID refer Get SSIDs Configured on a Managed Device call.

  • fromtime

    Is used to specify the start time in epoch format. It takes an integer value. The default value is -1.

  • totime

    Is used to specify end time in epoch format. It takes an integer value. The default value is -1.

  • protocol

    Is used to specify the protocol to filter data. It takes a string value. Possible values are A, B, and BG.

  • type

    Is used to specify the type of performance trend that is required. It takes String value.
    Possible values are activeapcounthistory, apdatatransferhistory, apassociationhistory, aperrorrate,
    clienttraffic, clientdatarate, apassociation, and clientretransmissionrate. It is a mandatory field.

  • boxid

    Is used to specify the client box ID. It takes an integer value. The default value is -1.
    It is a mandatory field. To retrieve the value for boxid refer Managed devices call.

  • frequencyband

    Is used to filter the data for the provided frequency band. Possible values are 2.4, 5 and ANY.
    It takes a string value. The default value is ANY.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices
/statistics/trend?devicecategory=MANAGED_AP&type=apdatatransferhistory&boxid=5
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains a performance trend for a managed device. The response
is in the application/json format. The content of the response body is listed below.

  • value

    Value of the requested trend type. It is an integer value. Sample value, 125986.

  • time

    Time in milliseconds. It is an integer value. Sample value, 1480311900.

  • totalCount

    No of data points. It is an integer value. Sample value, 1328842.

A sample response is as follows:

{
   "samples":[{
      "value": 125986,
      "time": 1490956200
   },
      . . .
      . . .
      . . .
   {
      "value": 67256,
      "time": 1490959800
   }],
   "totalCount": 1328842
}

Get Sorted List of Managed Devices

Description Fetches managed devices sorted by a given performance value.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/manageddevices/statistics/sorting?limit=<value>&
sortby=<value>&ascending=<value>&frequencyband=<value>&fromtime=
<value>&totime=<value>&ssid=<value>
  • limit

    Is used to specify the number of records to return. It takes an integer value. The default value is 10.

  • sortby

    Is used to specify the performance value to sort the data on. It takes a string value.
    Possible values are networktraffic and associations. The default value is networktraffic.

  • ascending

    Is set true to sort records in ascending order. It takes a boolean value. The default value is false.

  • frequencyband

    Is used to specify filter records of a frequency band. It takes a string value. Possible values are
    BAND_2_4_GHZ, BAND_5_GHZ and ANY. The default value is ANY.

  • fromtime

    Is used to specify the start time in epoch format. It takes an integer value. The default value is -1

  • totime

    Is used to specify end time in epoch format. It takes an integer value. The default value is -1.

  • ssid

    Is used to specify the list of SSIDs for which the results should be returned. It takes a string value.
    To retrieve the value for SSID refer Get SSIDs Configured on a Managed Device call.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/statistics
/sorting?frequencyband=BAND_2_4_GHZ&sortby=associations
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the sorted managed devices list that matches the filter criteria.
The response is in the application/json format.

Get Observing Managed Devices List

Description Fetches a list of managed devices that have reported a specified managed device.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/manageddevices/{boxid}/observingmanageddevices?
isthirdradiosupported=<value>&sortby=<value>&istroubleshootingoff=<value>
&ismeshenabled=<value>
  • boxid

    Is used to specify the managed device box ID. It takes an integer value. To retrieve the value for boxid
    refer Managed devices call. It is a mandatory parameter.

  • isthirdradiosupported

    Is used to filter the devices supporting third radio. It takes a boolean value.

  • ismeshenabled

    A true and false value indicates that whether the device is working in mesh mode or not. It takes a boolean value.

  • istroubleshootingoff

    Is used to filter the devices on which troubleshooting is ON or OFF. It takes a boolean value.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/4/
observingmanageddevices?isthirdradiosupported=true&istroubleshootingoff=false&
ismeshenabled=true
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The response
body contains a list of observing managed devices. The response is in the application/json
format. The content of the response body is listed below.

  • boxId

    The system-generated ID of the device. It is an integer value.

  • macAddress

    MAC address of the device. It is a string value.

  • name

    Name of the device. It is a string value.

  • signalStrength

    The signal strength of an observing device. It is an integer value.

  • signalVariance

    The signal variance of an observing device. It is an integer value.

  • channel2_4Ghz

    Channel number of 2.4Ghz radio. It is an integer value.

  • channel5Ghz

    Channel number of 5Ghz radio. It is an integer value.

  • numClients2_4Ghz

    The number of clients on the 2.4Ghz radio. It is an integer value.

  • numClients5Ghz

    The number of clients on the 5Ghz radio. It is an integer value.

  • locationId

    Location identifier for the device. The value is of the type LocationID JSON.

A sample response is as follows:

[{
   "boxId": 892,
   "macAddress": "00:11:74:D4:59:9F",
   "name": "Mojo_D4:59:9F",
   "signalStrength": -33,
   "signalVariance": 0,
   "channel2_4Ghz": 0,
   "channel5Ghz": 0,
   "numClients2_4Ghz": 0,
   "numClients5Ghz": 0,
   "locationId":
      {
         "type": "locallocationid",
         "id": 2
      }
}]

Get SSIDs Configured on a Manged Device

Description Fetches the list of SSIDs configured on a managed device.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/ssids?manageddeviceboxid=<value>
  • manageddeviceboxid

    Is used to specify Box ID of the managed device for which the SSIDs have to be fetched.
    If not specified SSIDs configured across all managed devices are returned. It takes an
    integer value.

Sample code
GET https://training.mojonetworks.com/new/webserviceV5/devices/ssids?manageddeviceboxid=5
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The response
body contains list of SSIDs. A sample response is as follows:

[
   "WebAppsDev",
   "phi_test",
   "WebAppsDev-a"
]

Get Devices Participating in An Event

Description Fetches devices participating in events.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/events/manageddevices?offset=<value>&limit=<value>
  • offset

    Is used to specify the start index of requested managed devices list. It takes an integer value.
    The default value is 0.

  • limit

    Is used to specify the no of requested managed devices list. It takes an integer value.
    The default value is 100. The maximum value is 1000.

Sample code
GET https://training.mojonetworks.com/new/webservice/V5/events/manageddevices
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains a list of managed devices participating in events.
The response is in the application/json format.

Change Managed Device Location

Description Changes the location of a managed device.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/devices/manageddevices/actions/CHANGE_LOCATION?
unplacedeviceforlocationchange=<value>&retaintemplate=<value>
  • retaintemplate

    A boolean value represents whether to retain the current device template when
    change location action is performed.

  • unplacedeviceforlocationchange

    A boolean value indicates that before changing the location, the device is to be unplaced or not.

Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/actions
/CHANGE_LOCATION?retaintemplate=true&unplacedeviceforlocationchange=true
Request Body This API call requires boxid and the details of the previous and new location to change the location,
which is passed as parameters in the request body. The parameters are passed in
the application/json format. You must provide the appropriate values for the
following JSON attributes:

  • boxid

    It is used to specify the device box ID. It takes an integer value. It is a mandatory field.
    To retrieve the value for box Id refer Managed Devices call.

  • locationId

    A group of attributes representing the location to be changed. For complete details about the JSON, click Location ID. To retrieve the value for location Id refer Managed Devices call.

A sample request body is as follows:

{
	"manualDeviceUpdateBoxIdWithLocationId":[{
	"boxid": 35,
	"locationId":
	{
		"type": "locallocationid",
		"id": -1
	}
	}],
	"argument":
	{
		"type": "location",
		"locationId":
		{
			"type": "locallocationid",
			"id": 0
		}
	}
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Modify Managed Device

Description Modifies the managed device. The action involves modifying the device name, the device location, the device template, etc.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/devices/manageddevices?locationid=<value>&nodeid=<value>&fields=<value>&retaintemplate=<value>&unplacedeviceforlocationchange=<value>
  • locationid

    Location identifier for the managed device. The value is of the type LocationID JSON.

  • nodeid

    Is used to specify child node id if the location belongs to the child server.
    It takes an integer value and is an optional parameter.

  • fields

    Specifies the attribute to be modified. It takes String value and is a mandatory parameter.

  • retaintemplate

    A boolean value represents whether to retain the current device template when
    change location action is performed.

  • unplacedeviceforlocationchange

    A boolean value indicates that before changing the location, the device is to be unplaced or not.

Sample code
https://training.mojonetworks.com/new/webservice/V6/devices/manageddevices?fields=locationid
Request Body The API call requires the details of the fields that are to be modified. It is mandatory to mention the macaddress of the device.
A sample request body is as follows:

{
            "boxId": 1,
            "locationId": {
                "type": "locallocationid",
                "id": 0
            },
            "macaddress": "88:DC:96:69:E8:71"
       }
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Customize Device Settings

Description This API is used to customize device settings when per device configuration is enabled.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/devices/manageddevices/actions/CUSTOMIZE_DEVICE_SETTINGS?
retaintemplate=<value>
  • retaintemplate

    A boolean value represents whether to retain current device template when change location
    action is performed.

Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/actions
/CUSTOMIZE_DEVICE_SETTINGS?retaintemplate=true
Request Body A sample request body is as follows:

{
    "boxIds":
    [
      2
    ],
    "argument":
	{
      "type": "devicecustomization",
      "customDeviceTemplate":
	  {
         "macAddress": "00:11:74:8C:00:EF",
         "customRadioSettings": 
		 [{
            "enableCustomTxPower": true,
            "customTxPower": 25,
            "transmitPowerConfigured": true,
            "operatingModeConfigured": true,
            "autoChannelSelectionInterval": 600
         }]
      },
      "perDeviceSettings":
	  {
         "macAddress": "00:11:74:8C:00:EF",
         "vlanEnabled": true,
         "vlansToBeMonitored": 2,
         "communicationVLAN": "2"
      }
   }
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Delete Managed Devices

Description Deletes managed devices.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/devices/manageddevices/actions/DELETE_DEVICES
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/actions
/DELETE_DEVICES
Request Body A sample request body is as follows:

{
   "manualDeviceUpdateBoxIdWithLocationId":
    [{
         "boxid": 35,
         "locationId":
        {
         "type": "locallocationid",
         "id": -1
        }
    }]
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Managed Devices Debug Logs

Description Sends request to start managed device debug logs. After successful
completion of the request, the user can download the debug logs using Get debug log history API
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/devices/manageddevices/actions/GET_SENSOR_DEBUG_LOGS
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/actions
/GET_SENSOR_DEBUG_LOGS
Request Body A sample request body is as follows:

{
   "manualDeviceUpdateBoxIdWithLocationId":
    [{
        "boxid": 36,
        "locationId":
        {
           "type": "locallocationid",
           "id": -1
        }
   }]
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Reboot Managed Devices

Description Reboots managed devices.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
PUT <Base_URL>/devices/manageddevices/actions/REBOOT_SENSORS
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/devices/manageddevices/
actions/REBOOT_SENSORS
Request Body A sample request body is as follows:

{
   "manualDeviceUpdateBoxIdWithLocationId":
   [{
         "boxid": 36,
         "locationId":{
         "type": "locallocationid",
         "id": -1
      }
   }]
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.

User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.

Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete Managed Devices

Description Deletes managed WiFi device.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
DELETE <Base_URL>/devices/manageddevices/{macaddress}?placedsensors=<Value>
  • macaddress

    Macaddress of the managed WiFi device to be deleted. It takes a string value. It is a mandatory field.

  • placedsensors

    A boolean value representing whether the managed devices placed on the floor should be deleted or not.
    If set to true it will allow deleting the managed device. If set to false it will return an error on the actions.

Sample code
DELETE https://training.mojonetworks.com/new/webservice/V6/devices/manageddevices
/00:11:74:8C:94:DF?placedsensors=true
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.
JSON Table

Attribute Data Type Description
boxId long System-generated ID.
name String Name of the device.
macaddress String MAC address of the device.
locationId application/json Location identifier for the device. The value is of the type Location ID JSON.
deviceMode String Mode in which the device is currently operating.
templateId int System generated value to identify the template.
templateName String Name of the template.
model String Mojo device model number.
placed boolean A true or false value indicating whether the Mojo device has been placed on the floor map layout for the location.
softwareVersion String Build number of the software on the device.
capability int
monitoredVlanCount int Number of VLANs monitored.
totalVlanCount int Total number of visible VLANs.
platformId int System generated integer value to identify platform.
meshEnabled boolean A true or false value indicating whether the Mesh Mode is Enabled/Disabled.
failSafeMode boolean A true or false value indicating whether the device is in fail safe mode.
deviceNote String Device tags
ipAddress long IP address of the authorized sensor. The field is blank if the sensor is rogue or external.
active boolean A true or false value indicating whether the device is active or inactive.
upgradeStatus int Upgrade status of the managed device.
troubleshootingStatus int Indicates if troubleshooting is in progress for the managed device.
radios application/json List of radios
radios/radioId int System-generated ID to identify radio.
radios/active boolean A true or false value indicating acticve status of radio.
radios/noiseFloor int Noise signal strength value in dBm.
radios/worstClientRssi int Signal strength of worst client connected to a radio.
radios/txPower int Transmission power in dBm
radios/rfUtilization int RF utilization in percentage
radios/capability int Operation mode capabilities of the radio like 802.11n, 802.11ac, Super AG, Turbo etc
radios/apMode boolean Indicates the mode of the radio.
radios/operatingBand String Indicates the operating protocol of radio.
radios/retryRate int Retransimission rate in percentage.
radios/upstreamUsage int Up stream data usage in KB
radios/downstreamUsage int Down stream data usage in KB
radios/wirelessInterfaces application/json Wireless interface information
radios/wirelessInterfaces/bssid long BSSID configured on managed device.
radios/wirelessInterfaces/ssid String It is an operating SSID for an AP.
radios/wirelessInterfaces/active boolean A true or false value indicating whether BSSID is active or inactive.
radios/wirelessInterfaces/numAssocClients int Number of active clients associated with the BSSID.
radios/wirelessInterfaces/security int Security standard applied to the BSSID.
radios/wirelessInterfaces/secAuth int Procedure used by APs to verify the identity of a client
radios/wirelessInterfaces/secGCS int Specifies the encryption used for broadcast or multicast communication from the AP. The applicable values are:

  • 0 (None)
  • 1 (WEP40)
  • 2 (WEP104)
  • 4 (TKIP)
  • 8 (CCMP)
  • 32 (unknown)
  • 64 (use group)
  • 128 (vendor specific)
radios/wirelessInterfaces/secPWCS int Encryption used for uni cast communication between the AP and a Client. The applicable values are:

  • 0 (None)
  • 1 (WEP40)
  • 2 (WEP104)
  • 4 (TKIP)
  • 8 (CCMP)
  • 32 (unknown)
  • 64 (use group)
  • 128 (vendor specific
radios/channel int Channel number on which the radio operates.
spectrumAnalysisState int State of spectrum analysis session on device.
quarantineStatus String Indicates quarentine status of sensor.
upSince long Date and time since the Mojo device is up or down.
previousLink String Link for previous page of results.
nextLink string Link for next page of results.
totalCount int Total number of managed devices retrieved based on the filter criteria.

Sample JSON
{
    "managedDevices": [
        {
            "boxId": 1,
            "name": "Mojo_A3:A9:FF",
            "vendorName": "Mojo",
            "firstDetectedTime": 1394019224180,
            "macaddress": "00:11:74:A3:A9:FF",
            "locationId": {
                "type": "locallocationid",
                "id": -1
            },
            "deviceMode": "SENSOR",
            "templateId": -2,
            "templateName": "System Template",
            "model": "SS-300-AT-C-60",
            "placed": false,
            "softwareVersion": "7.0.30",
            "capability": 33,
            "monitoredVlanCount": 0,
            "totalVlanCount": 0,
            "platformId": 11,
            "meshEnabled": false,
            "failSafeMode": false,
            "deviceNote": null,
            "ipAddress": "192.168.9.63",
            "active": false,
            "upgradeStatus": 0,
            "troubleshootingStatus": 0,
            "radios": null,
            "spectrumAnalysisState": "STOPPED",
            "quarantineStatus": "QUARANTINE_STATUS_OFF",
            "clientConnectivityState": "OFF",
            "targetAPClientConnectivityStatus": "OFF",
            "networkTag": null,
            "powerSource": "NOT_AVAILABLE",
            "bleStatus": "NOT_AVAILABLE",
            "upSince": 1394213971490
        },
        {
            "boxId": 2,
            "name": "Mojo_9C:BC:9F",
            "vendorName": "Mojo",
            "firstDetectedTime": 1513576892217,
            "macaddress": "00:11:74:9C:BC:9F",
            "locationId": {
                "type": "locallocationid",
                "id": -1
            },
            "deviceMode": "AP",
            "templateId": -2,
            "templateName": "System Template",
            "model": "C-55",
            "placed": false,
            "softwareVersion": "8.2.1-902.34",
            "capability": 33,
            "monitoredVlanCount": 0,
            "totalVlanCount": 1,
            "platformId": 13,
            "meshEnabled": false,
            "failSafeMode": false,
            "deviceNote": null,
            "ipAddress": "172.17.30.96",
            "active": true,
            "upgradeStatus": 0,
            "troubleshootingStatus": 0,
            "radios": [
                {
                    "radioId": 2,
                    "active": false,
                    "noiseFloor": 0,
                    "worstClientRssi": 0,
                    "txPower": 0,
                    "rfUtilization": 0,
                    "capability": 12,
                    "apMode": true,
                    "operatingBand": "BAND_2_4_GHZ",
                    "retryRate": 0,
                    "upstreamUsage": 0,
                    "downstreamUsage": 0,
                    "wirelessInterfaces": [
                        {
                            "bssid": "00:11:74:9C:BC:92",
                            "ssid": "sched_always_up",
                            "active": false,
                            "numAssocClients": 0,
                            "security": 1,
                            "secAuth": 0,
                            "secGCS": 0,
                            "secPWCS": 0
                        },
                        {
                            "bssid": "00:11:74:9C:BC:91",
                            "ssid": "m-sch-g",
                            "active": false,
                            "numAssocClients": 0,
                            "security": 8,
                            "secAuth": 1,
                            "secGCS": 8,
                            "secPWCS": 8
                        },
                        {
                            "bssid": "00:11:74:9C:BC:90",
                            "ssid": "Documentation",
                            "active": true,
                            "numAssocClients": 0,
                            "security": 8,
                            "secAuth": 1,
                            "secGCS": 8,
                            "secPWCS": 8
                        }
                    ],
                    "channel": 0,
                    "channelWidth": 0,
                    "channelOffset": 0,
                    "mcsSet11ac": 0,
                    "beaconInterval": 100,
                    "supportedRates": -2144683266
                },
                {
                    "radioId": 1,
                    "active": true,
                    "noiseFloor": -105,
                    "worstClientRssi": 0,
                    "txPower": 21,
                    "rfUtilization": 4,
                    "capability": 3,
                    "apMode": true,
                    "operatingBand": "BAND_2_4_GHZ",
                    "retryRate": 0,
                    "upstreamUsage": 0,
                    "downstreamUsage": 0,
                    "wirelessInterfaces": [
                        {
                            "bssid": "00:11:74:9C:BC:92",
                            "ssid": "sched_always_up",
                            "active": false,
                            "numAssocClients": 0,
                            "security": 1,
                            "secAuth": 0,
                            "secGCS": 0,
                            "secPWCS": 0
                        },
                        {
                            "bssid": "00:11:74:9C:BC:91",
                            "ssid": "m-sch-g",
                            "active": false,
                            "numAssocClients": 0,
                            "security": 8,
                            "secAuth": 1,
                            "secGCS": 8,
                            "secPWCS": 8
                        },
                        {
                            "bssid": "00:11:74:9C:BC:90",
                            "ssid": "Documentation",
                            "active": true,
                            "numAssocClients": 0,
                            "security": 8,
                            "secAuth": 1,
                            "secGCS": 8,
                            "secPWCS": 8
                        }
                    ],
                    "channel": 6,
                    "channelWidth": 0,
                    "channelOffset": 0,
                    "mcsSet11ac": 0,
                    "beaconInterval": 100,
                    "supportedRates": -2144683266
                }
            ],
            "spectrumAnalysisState": "STOPPED",
            "quarantineStatus": "QUARANTINE_STATUS_OFF",
            "clientConnectivityState": "OFF",
            "targetAPClientConnectivityStatus": "OFF",
            "networkTag": "192.168.55.0/24",
            "powerSource": "NOT_AVAILABLE",
            "bleStatus": "NOT_AVAILABLE",
            "upSince": 1513749001743
        }
    ],
    "previousLink": null,
    "nextLink": "https://192.168.55.179/new/webservice/v5/devices/manageddevices?offset=2&limit=100",
    "totalCount": 2,
    "templateToPlatformRadioSettingsDetails": null
}