local_policy

AP Classification Policy

AP classification policy allows you to specify policies for different AP categories. Authenticity of APs is extremely important in the network as if there is any unauthorised AP connected to network it can result into serious issues. If you want to classify networked APs as authorized APs, select the Move networked APs to checkbox and select the Authorized option from the drop-down list next to this check box. If you want to classify non-networked APs as external APs, select the Move non-networked APs to the External Folder check box. If you want to classify networked APs as rogue APs, select the Move networked APs to checkbox and select the Rogue option from the drop-down list next to this check box.

JSON Table

Parameter Data Type Description
policyCreatedAtLocId application/json ID of the location at which the policy has been defined. For details
about the JSON, click Location
ID.
policyType String A read-only field for internal use.
autoClassifyPotentiallyExternal boolean A true or false value indicating whether the potentially external APs
in the uncategorized list are automatically classified as External.
autoClassifyPotentiallyRogue boolean A true or false value indicating whether the potentially rogue APs in
the uncategorized list are automatically classified as Rogue.

Copy Sample JSON
Sample JSON 
{
    "policyCreatedAtLocId": {
        "type": "locallocationid",
        "id": 0
    },
    "policyType": "AP_CLASSIFICATION",
    "autoClassifyPotentiallyExternal": true,
    "autoClassifyPotentiallyRogue": true
}
API Calls
Get

/V5/policies/apclassification/{fetch_factory_default}

Put

/V5/policies/apclassification

Put

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

Post

/V5/policies/apclassification

Delete

/V5/policies/apclassification

Get AP Classification Policy

Description This API is used to fetch the AP Classification Policy at a specified location
from Wireless Manager or Arista Cloud Services.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
Get <Base_URL>/policies/apclassification/{fetch_factory_default}?
locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the AP Classification Policy
    is fetched. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.

  • fetch_factory_default

    Is a boolean value specifying whether factory default policies will be fetched
    or user-defined policies. If set to true the factory default policies are fetched,
    and if set to false user-defined policies are fetched.
Sample code
Get https://training.mojonetworks.com/new/webservice/V5/policies/
apclassification/true?locationid=2
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 AP Classification Policy. The response is in the application/json format.

Customize AP Classification Policy

Description This API is used to customize the AP Classification Policy at a specified location in
Wireless Manager or Arista Cloud Services. After calling this API, the policy
can be modified by calling the Modify AP Classification Policy API at
the specified location.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
PUT <Base_URL>/policies/apclassification?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the AP Classification Policy
    is customized. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/policies/apclassification?
locationid=3
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 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.

Modify AP Classification Policy

Description This API is used to modify AP Classification Policy at a specified location
in Wireless Manager or Arista Cloud Services. Before calling this API, the
policy must be customized by calling the Customize AP Classification Policy
API at the specified location.
Users with the roles can call this API:superuser, administrator, operator, and viewer.
Syntax
POST <Base_URL>/policies/apclassification?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the AP Classification Policy
    is modified. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.
Sample code
POST https://training.mojonetworks.com/new/webservice/V5/policies/
apclassification?locationid=2
Request Body This API call takes optional request body parameters.

A sample request will have a structure as follows:

{
...
List of AP Classification Policy attributes.
...
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any information.

Inherit AP Classification Policy

Description This API is used to inherit AP Classification Policy at a specified location
from its parent location in the Mojo Server or the Arista Cloud Services. The
AP Classification Policy, by default, is inherited from the parent location. This
API can be called to inherit the policy from the parent location if the
Customize AP Classification Policy API was called at a specified
location earlier. On calling this API, the customized policy is deleted and the policy
defined on the parent location is inherited.
Users with the roles can call this API: superuser, administrator, operator and viewer.
Syntax
DELETE <Base_URL>/policies/apclassification?locationid=<value>
&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the AP Classification Policy
    is inherited. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.
Sample code
DELETE
https://training.mojonetworks.com/new/webservice/V5/policies/
apclassification?locationid=2
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 information.

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.