Regional Domains

This API is used to fetch country details from the Arista Server or the Arista Cloud Services.

API Calls

/V5/templates/regionaldomains

Get Regional Domains

Description Fetch’s country details from the Arista Server or the Arista Cloud Services.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/templates/regionaldomains
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/templates/regionaldomains
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 country code and name. The response is in the application/json format.

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.

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.
JSON Table

Attribute Data Type Description
newCode int System-generated ID of the country.
name String Name of the country.

Sample JSON
[[
    {
        "newCode": 792,
        "name": "Turkey"
    },
    {
        "newCode": 788,
        "name": "Tunisia"
    },
    {
        "newCode": 246,
        "name": "Finland"
    },
    {
        "newCode": 528,
        "name": "Netherlands"
    },
    {
        "newCode": 800,
        "name": "Uganda"
    },
    {
        "newCode": 250,
        "name": "France"
    },
    {
        "newCode": 524,
        "name": "Nepal"
    },
    {
        "newCode": 254,
        "name": "French Guiana"
    },
    {
        "newCode": 533,
        "name": "Aruba"
    },
    {
        "newCode": 9998,
        "name": "Nigeria"
    },
    {
        "newCode": 530,
        "name": "Netherlands Antilles"
    },
    {
        "newCode": 4059,
        "name": "Japan"
    },
    {
        "newCode": 233,
        "name": "Estonia"
    },
    {
        "newCode": 784,
        "name": "United Arab Emirates"
    },
    {
        "newCode": 780,
        "name": "Trinidad & Tobago"
    },
    {
        "newCode": 760,
        "name": "Syrian Arab Republic"
    },
    {
        "newCode": 276,
        "name": "Germany"
    },
    {
        "newCode": 756,
        "name": "Switzerland"
    },
    {
        "newCode": 8,
        "name": "Albania"
    },
    {
        "newCode": 484,
        "name": "Mexico"
    },
    {
        "newCode": 12,
        "name": "Algeria"
    },
    {
        "newCode": 764,
        "name": "Thailand"
    },
    {
        "newCode": 492,
        "name": "Monaco"
    },
    {
        "newCode": 258,
        "name": "French Polynesia"
    },
    {
        "newCode": 504,
        "name": "Morocco"
    },
    {
        "newCode": 499,
        "name": "Montenegro"
    },
    {
        "newCode": 752,
        "name": "Sweden"
    },
    {
        "newCode": 512,
        "name": "Oman"
    },
    {
        "newCode": 268,
        "name": "Georgia"
    },
    {
        "newCode": 32,
        "name": "Argentina"
    },
    {
        "newCode": 31,
        "name": "Azerbaijan"
    },
    {
        "newCode": 312,
        "name": "Guadeloupe"
    },
    {
        "newCode": 578,
        "name": "Norway"
    },
    {
        "newCode": 40,
        "name": "Austria"
    },
    {
        "newCode": 308,
        "name": "Grenada"
    },
    {
        "newCode": 858,
        "name": "Uruguay"
    },
    {
        "newCode": 320,
        "name": "Guatemala"
    },
    {
        "newCode": 860,
        "name": "Uzbekistan"
    },
    {
        "newCode": 586,
        "name": "Pakistan"
    },
    {
        "newCode": 48,
        "name": "Bahrain"
    },
    {
        "newCode": 591,
        "name": "Panama"
    },
    {
        "newCode": 862,
        "name": "Venezuela"
    },
    {
        "newCode": 316,
        "name": "Guam"
    },
    {
        "newCode": 44,
        "name": "Bahamas"
    },
    {
        "newCode": 834,
        "name": "Tanzania"
    },
    {
        "newCode": 56,
        "name": "Belgium"
    },
    {
        "newCode": 600,
        "name": "Paraguay"
    },
    {
        "newCode": 50,
        "name": "Bangladesh"
    },
    {
        "newCode": 598,
        "name": "Papua New Guinea"
    },
    {
        "newCode": 52,
        "name": "Barbados"
    },
    {
        "newCode": 51,
        "name": "Armenia"
    },
    {
        "newCode": 604,
        "name": "Peru"
    },
    {
        "newCode": 841,
        "name": "United States"
    },
    {
        "newCode": 842,
        "name": "United States (Public Safety)"
    },
    {
        "newCode": 304,
        "name": "Greenland"
    },
    {
        "newCode": 608,
        "name": "Philippines"
    },
    {
        "newCode": 300,
        "name": "Greece"
    },
    {
        "newCode": 60,
        "name": "Bermuda"
    },
    {
        "newCode": 818,
        "name": "Egypt"
    },
    {
        "newCode": 344,
        "name": "Hong Kong"
    },
    {
        "newCode": 70,
        "name": "Bosnia & Herzegovina"
    },
    {
        "newCode": 68,
        "name": "Bolivia"
    },
    {
        "newCode": 340,
        "name": "Honduras"
    },
    {
        "newCode": 554,
        "name": "New Zealand"
    },
    {
        "newCode": 352,
        "name": "Iceland"
    },
    {
        "newCode": 826,
        "name": "United Kingdom"
    },
    {
        "newCode": 558,
        "name": "Nicaragua"
    },
    {
        "newCode": 76,
        "name": "Brazil"
    },
    {
        "newCode": 348,
        "name": "Hungary"
    },
    {
        "newCode": 804,
        "name": "Ukraine"
    },
    {
        "newCode": 84,
        "name": "Belize"
    },
    {
        "newCode": 807,
        "name": "Macedonia"
    },
    {
        "newCode": 96,
        "name": "Brunei Darussalam"
    },
    {
        "newCode": 332,
        "name": "Haiti"
    },
    {
        "newCode": 380,
        "name": "Italy"
    },
    {
        "newCode": 112,
        "name": "Belarus"
    },
    {
        "newCode": 372,
        "name": "Ireland"
    },
    {
        "newCode": 100,
        "name": "Bulgaria"
    },
    {
        "newCode": 646,
        "name": "Rwanda"
    },
    {
        "newCode": 376,
        "name": "Israel"
    },
    {
        "newCode": 643,
        "name": "Russia"
    },
    {
        "newCode": 642,
        "name": "Romania"
    },
    {
        "newCode": 364,
        "name": "Iran"
    },
    {
        "newCode": 356,
        "name": "India"
    },
    {
        "newCode": 116,
        "name": "Cambodia"
    },
    {
        "newCode": 360,
        "name": "Indonesia"
    },
    {
        "newCode": 412,
        "name": "Korea Republic"
    },
    {
        "newCode": 144,
        "name": "Sri Lanka"
    },
    {
        "newCode": 414,
        "name": "Kuwait"
    },
    {
        "newCode": 620,
        "name": "Portugal"
    },
    {
        "newCode": 887,
        "name": "Yemen"
    },
    {
        "newCode": 616,
        "name": "Poland"
    },
    {
        "newCode": 404,
        "name": "Kenya"
    },
    {
        "newCode": 408,
        "name": "North Korea"
    },
    {
        "newCode": 156,
        "name": "China"
    },
    {
        "newCode": 638,
        "name": "Reunion"
    },
    {
        "newCode": 5001,
        "name": "Canada"
    },
    {
        "newCode": 398,
        "name": "Kazakhstan"
    },
    {
        "newCode": 634,
        "name": "Qatar"
    },
    {
        "newCode": 400,
        "name": "Jordan"
    },
    {
        "newCode": 158,
        "name": "Taiwan"
    },
    {
        "newCode": 630,
        "name": "Puerto Rico"
    },
    {
        "newCode": 388,
        "name": "Jamaica"
    },
    {
        "newCode": 5000,
        "name": "Australia"
    },
    {
        "newCode": 152,
        "name": "Chile"
    },
    {
        "newCode": 716,
        "name": "Zimbabwe"
    },
    {
        "newCode": 175,
        "name": "Mayotte"
    },
    {
        "newCode": 446,
        "name": "Macau"
    },
    {
        "newCode": 170,
        "name": "Colombia"
    },
    {
        "newCode": 442,
        "name": "Luxembourg"
    },
    {
        "newCode": 440,
        "name": "Lithuania"
    },
    {
        "newCode": 438,
        "name": "Liechtenstein"
    },
    {
        "newCode": 705,
        "name": "Slovenia"
    },
    {
        "newCode": 710,
        "name": "South Africa"
    },
    {
        "newCode": 191,
        "name": "Croatia"
    },
    {
        "newCode": 428,
        "name": "Latvia"
    },
    {
        "newCode": 188,
        "name": "Costa Rica"
    },
    {
        "newCode": 724,
        "name": "Spain"
    },
    {
        "newCode": 422,
        "name": "Lebanon"
    },
    {
        "newCode": 682,
        "name": "Saudi Arabia"
    },
    {
        "newCode": 208,
        "name": "Denmark"
    },
    {
        "newCode": 480,
        "name": "Mauritius"
    },
    {
        "newCode": 474,
        "name": "Martinique"
    },
    {
        "newCode": 203,
        "name": "Czech Republic"
    },
    {
        "newCode": 688,
        "name": "Republic Of Serbia"
    },
    {
        "newCode": 470,
        "name": "Malta"
    },
    {
        "newCode": 196,
        "name": "Cyprus"
    },
    {
        "newCode": 222,
        "name": "El Salvador"
    },
    {
        "newCode": 458,
        "name": "Malaysia"
    },
    {
        "newCode": 702,
        "name": "Singapore"
    },
    {
        "newCode": 703,
        "name": "Slovakia"
    },
    {
        "newCode": 218,
        "name": "Ecuador"
    },
    {
        "newCode": 704,
        "name": "Vietnam"
    },
    {
        "newCode": 454,
        "name": "Malawi"
    },
    {
        "newCode": 214,
        "name": "Dominican Republic"
    }
]]