sites
sites
Configuration Editor for API to add, modify, delete, and get sites. resource.
Read/write properties
site_location <String>
Site location.. Minimum length = 1 Maximum length = 1000
mode <String>
Operating mode of this site. Possible values = [primary_mcn,secondary_mcn,primary_rcn,secondary_rcn,client]
region <String>
Region to which the site belongs to. Minimum length = 1 Maximum length = 42
model <String>
site model. Possible values = [cb210,cb400,cb410,cb1000,cb2000,cb2100,cb4000,cb4100,cb5100,cbvpx,cbvpxl]
secure_key <String>
Hexadecimal secure key used for encryption and membership verification in the Virtual WAN network. This field is optional. If the value is not provided, API generates the secure key.. Minimum length = 8 Maximum length = 32
package_name <String>
Config package name using which the site API operation should be performed.. Minimum length = 1 Maximum length = 141
site_name <String>
Site Name. Minimum length = 1 Maximum length = 32
Read only properties
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/sites
Description: Use this operation to add site
HTTP Method: POST
Request Payload: JSON
{"sites": { "site_location":<String_value> , "mode":<String_value> , "region":<String_value> , "model":<String_value> , "secure_key":<String_value> , "package_name":<String_value> , "site_name":<String_value> }}
Response Payload: JSON
{ "sites":{ "site_location":<String_value>
, "mode":<String_value> , "region":<String_value> , "model":<String_value> , "secure_key":<String_value> , "package_name":<String_value> , "site_name":<String_value> }]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/sites/site_name=<String>,package_name=<String>
Description: Use this operation to delete a site
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/sites/package_name=<package_name>
Description: Use this operation to get the list of sites
HTTP Method: GET
Response Payload: JSON
{"sites":[{ "site_location":<String_value>
, "mode":<String_value> , "region":<String_value> , "model":<String_value> , "secure_key":<String_value> , "package_name":<String_value> , "site_name":<String_value> }]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/sites
Description: Use this operation to modify site
HTTP Method: PUT
Request Payload: JSON
{"sites":{ "site_location":<String_value> , "mode":<String_value> , "region":<String_value> , "model":<String_value> , "secure_key":<String_value> , "package_name":<String_value> , "site_name":<String_value> }}
Response Payload: JSON
{ "sites":[{ "site_location":<String_value>
, "mode":<String_value> , "region":<String_value> , "model":<String_value> , "secure_key":<String_value> , "package_name":<String_value> , "site_name":<String_value> }]}