Wireless Manager System Calls

Wireless Manager System API calls comprise of the login, Logout, and all the system calls. These API calls help you login to the Wireless Manager server and access its services. Using the system calls, one can retrieve the information like system version, API version, timezone IDs, and timestamp.

API Calls
Get

/V5/system/version

Get

/V5/system/apiversion

Get

/V5/system/timestamp

Get

/V5/system/timezoneids

Get

/V7/system/info

Post

/login/key/{clientidentifier}/{timeout}

Post

/logout

Post

/V5/login/keepsessionalive

Log In to Wireless Manager

Description Logs in to the Wireless Manager Service with a valid key ID-value pair.
Who Can Execute? Any user can execute this API call.
Syntax
POST  <Base_URL>/login/key/{clientidentifier}/{timeout}?getClusterChildrenData=<value>
  • clientidentifier

    It is a mandatory user-defined string of maximum 20 characters that identifies the client making the API call. For example, modScanWifi.

  • timeout

    It is the time in seconds for which the session will be active after the successful login. For example, 3600, indicating the session must be active for one hour after a successful login.

  • getClusterChildrenData

    This parameter has the default value set to false and is applicable only in a server cluster environment. Setting this to true in the API call indicates all cluster children data have to be fetched for all the applicable calls in the session created by this login call. It is an optional query parameter.
Sample code
POST https://training.mojonetworks.com/new/webservice/login/key/modScanWifi/3600?getClusterChildrenData=true
Request Body This API call requires the authentication type and the corresponding key ID-value pair for login, which are passed as parameters in the request body. The parameters are passed in the application/json format. Below is the list of all the mandatory attributes, required in the request body with the appropriate description and the applicable values.

  • type

    It is the authentication type. It takes String value. Sample value, apikeycredentials.

  • keyId

    The Key ID. The key ID and value are system-generated and can be created from Launchpad. The key must have privileges on the Wireless Manager service. It takes String value.

  • keyValue

    The corresponding key value. It takes String value.

A sample request body is as follows:

{
   "type":"apikeycredentials",
   "keyId":"KEY-ATN59618-1",
   "keyValue":"42ff84734541cbd98f674b02555330ef"
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the details of the key, used to log in and the list of locations for which the user has access. The response is in the application/json format.

Log Out of Wireless Manager

Description Logs out from the Arista Server or the Arista Cloud Services and ends the corresponding session.
Who Can Execute? Any user can execute this API call.
Syntax
POST  <Base_URL>/logout
Sample code
POST https://training.mojonetworks.com/new/webservice/logout
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 does not contain any information.

Keep Session Alive

Description Keeps the current user session active post successful login to the Arista Server or the Arsita Cloud Services. Applicable only if a session is active. On successful execution keeps the user session active for a further time period as specified in the original Login to Wireless Manager API call.
Who Can Execute? Any user can execute this API call.
Syntax
POST  <Base_URL>/login/keepsessionalive
Sample code
POST https://training.mojonetworks.com/new/webservice/v5/login/keepsessionalive
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 does not contain any other information.

Get Wireless Manager Server Version

Description Provides the version of the Arista Server. In the case of an Arista Cloud Service user, this API call will fetch the version of the server on which the customer account is provisioned.
Who Can Execute? Any user can execute this API call.
Syntax
GET  <Base_URL>/system/version?locationid=<value>
  • locationid

    Specifies the id of the server location, in a server cluster environment, for which the server version has to be fetched. It is an optional parameter and takes integer value. To retrieve the appropriate location ID refer Location.
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/system/version?locationid=1
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 details of the server version in the application/json format.  The following list describes the contents of the response body.

  • version

    The server version. It is a String value.

  • build

    The server build. It is a String value.

A sample request body is as follows:

{
   "version":"8.0",
   "build":"8.0.22",
}

Get Wireless Manager API Version

Description Provides the API version supported by the system.
Who Can Execute? Any user can execute this API call.
Syntax
GET  <Base_URL>/system/apiversion
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/system/apiversion
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 details of the API version. The response is in the application/json format. A sample response is as follows:

{
   "V",
   "5"
}

Get Timezone IDs

Description Provides the timezone IDs supported by the Arista Server or Arista Cloud.
Who Can Execute? Any user can execute this API call.
Syntax
GET <Base_URL>/system/timezoneids
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/system/timezoneids
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 details of the supported timezones. The response is in the application/json format. The following list describes the contents of the response body.

  • displayString

    A string value specifying how the timezone is displayed.

  • id

    A string value representing the timezone.

A sample response is as follows:

[
    {
        "displayString": "(GMT -12:00)   Etc/GMT+12",
        "id": "Etc/GMT+12"
    },
    {
        "displayString": "(GMT -11:00)   Etc/GMT+11",
        "id": "Etc/GMT+11"
    },
    {
        "displayString": "(GMT -11:00)   Pacific/Midway",
        "id": "Pacific/Midway"
    },
    . . .
    . . .
    . . .
]

Get System Timestamp

Description Provide’s server time in UTC.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/system/timestamp
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/system/timestamp
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 System Timestamp. A sample response is as follows:

1487919542403

Fetch System Info Policy

Description Returns the global policy system information along with the aware configuration.
Who Can Execute? Superuser, and Administrator.
Syntax
GET <Base URL>/system/info
Sample code
GET https://training.mojonetworks.com/new/webservice/V7/system/info
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 global policy system information along with the aware configuration. The response is in the application/json format. The following list describes the contents of the response body.

  • serverID
  • sensorCommunicationPort
  • maxSensorsAllowed
  • maxAllowableAPConversions
  • expiryDate
  • serialNumber
  • buildNumber
  • version
  • mtStatus
  • instanceID
  • applianceModel
  • os
  • serverUrl
  • backupFiles
  • backupFiles/backupFileName
  • backupFiles/fileSizeInBytes
  • backupFiles/creationDate
  • backupFiles/dbBackupType
  • awareConfig
  • awareConfig/hostname
  • awareConfig/onPremHostname
  • awareConfig/awareInstalledLocally

A sample response is as follows:

{
    "serverID": 1,
    "sensorCommunicationPort": 3851,
    "maxSensorsAllowed": 600,
    "maxAllowableAPConversions": 600,
    "expiryDate": 1632009600000,
    "serialNumber": "000C299F5A79",
    "buildNumber": "mwm-trunk.23",
    "version": "8.8",
    "mtStatus": false,
    "instanceID": 0,
    "applianceModel": "VM",
    "os": "CentOS 6.2",
    "serverUrl": "https://wifi-security-server",
    "backupFiles": [
        {
            "backupFileName": "MWM_backup_000C299F5A79_20181202033028.tgz",
            "fileSizeInBytes": 762136,
            "creationDate": 1543701634000,
            "dbBackupType": "FULL"
        }
    ],
    "awareConfig": {
        "hostname": null,
        "onPremHostname": "aware-on-prem.mojonetworks.com",
        "awareInstalledLocally": true
    }
}