local_policy

Email Notification Policy

Email Notification policy allows sending only authenticated mails by configuring SMTP (Simple Mail Transfer Protocol) policy. Only users with administrator access can configure the settings. Proper credentials are required for the authentication to happen. You can check the SMTP settings by sending a test mail and ensuring if the configurations are set right.

JSON Table

Parameter Data Type Description
policyCreatedAtLocId application/json ID of the location at which the policy has been defined, which is a JSON object. For details about the JSON, click Location ID.
policyType String A read-only field for internal use.
notifiedEmails List of strings The email addresses that must be notified for events that have the sendEmail set to true.

Copy Sample JSON
Sample JSON 
{
    "policyCreatedAtLocId": {
        "type": "locallocationid",
        "id": 0
    },
    "policyType": "EMAIL_NOTIFICATION_POLICY",
    "notifiedEmails": []
}
API Calls
Get

/V5/policies/emailnotification/{fetch_factory_default}

Put

/V5/policies/emailnotification

Put

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

Post

/V5/policies/emailnotification

Delete

/V5/policies/emailnotification

Get Email Notification Policy

Description This API is used to fetch the Email Notification 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/emailnotification/{fetch_factory_default}?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Email Notification 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/
emailnotification/true?locationid=0
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 Email Notification Policy. The response is in the application/json format.

Customize Email Notification Policy

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

Here,

  • locationid

    It is an integer value specifying the location for which the Email Notification 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/
emailnotification?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 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 Email Notification Policy

Description This API is used to modify Email Notification 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 Email Notification Policy
API at the specified location.
Users with the roles can call this API:superuser, administrator, operator, and viewer.
Syntax
POST <Base_URL>/policies/emailnotification?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Email Notification 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/
emailnotification?locationid=2
Request Body This API call requires the modified details of the Email Notification Policy,
which are 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 mandatory JSON attributes.

  • notifiedEmails

A sample request will have a structure as follows:

{
...
List of Email Notification Policy with mandatory attribute mentioned above.
...
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any information.

Inherit Email Notification Policy

Description This API is used to inherit Email Notification Policy at a specified location
from its parent location in the Mojo Server or the Arista Cloud Services. The
Email Notification 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 Email Notification Policy API was called at a specified
location earlier. On calling this API, the customized Email Notification 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/emailnotification?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Email Notification 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/
emailnotification?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.