region
region
Configuration Editor for API to add, modify, delete, and get regions resource.
Read/write properties
is_default <Boolean>
If enabled, the Region will be used as the default Region for the network.
region_name <String>
Region Name. Minimum length = 1 Maximum length = 32
package_name <String>
Config package name using which the region API operation should be performed.. Minimum length = 1 Maximum length = 141
region_description <String>
Region description. Maximum length = 128
force_internal_vip_matching <Boolean>
When enabled, all non-private Virtual IP Addressess in the Region will be forced to match the configured subnets.
id <String>
Config package name using which the region API operation should be performed..
allow_external_vip_matching <Boolean>
When enabled, non-private Virtual IP Addresses from other regions will be allowed to match the configured subnets.
subnets <subnets_obj[]>
Subnets for this region.
Read only properties
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/region
Description: Use this operation to add a region
HTTP Method: POST
Request Payload: JSON
{"region": { "is_default":<Boolean_value> , "region_name":<String_value> , "package_name":<String_value> , "region_description":<String_value> , "force_internal_vip_matching":<Boolean_value> , "id":<String_value> , "allow_external_vip_matching":<Boolean_value> , "subnets":[{ "network":<String_value> , "routing_domain":<String_value> }] }}
Response Payload: JSON
{ "region":{ "is_default":<Boolean_value>
, "region_name":<String_value> , "package_name":<String_value> , "region_description":<String_value> , "force_internal_vip_matching":<Boolean_value> , "id":<String_value> , "allow_external_vip_matching":<Boolean_value> , "subnets":[{ "network":<String_value> , "routing_domain":<String_value> }]}]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/region/package_name=<String>,id=<id>
Description: Use this operation to delete a region. This operation also deletes all the sites in the region
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/region/package_name=<package_name>
Description: Use this operation to get the regions
HTTP Method: GET
Response Payload: JSON
{"region":[{ "is_default":<Boolean_value>
, "region_name":<String_value> , "package_name":<String_value> , "region_description":<String_value> , "force_internal_vip_matching":<Boolean_value> , "id":<String_value> , "allow_external_vip_matching":<Boolean_value> , "subnets":[{ "network":<String_value> , "routing_domain":<String_value> }]}]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/region
Description: Use this operation to modify a region
HTTP Method: PUT
Request Payload: JSON
{"region":{ "is_default":<Boolean_value> , "region_name":<String_value> , "package_name":<String_value> , "region_description":<String_value> , "force_internal_vip_matching":<Boolean_value> , "id":<String_value> , "allow_external_vip_matching":<Boolean_value> , "subnets":[{ "network":<String_value> , "routing_domain":<String_value> }] }}
Response Payload: JSON
{ "region":[{ "is_default":<Boolean_value>
, "region_name":<String_value> , "package_name":<String_value> , "region_description":<String_value> , "force_internal_vip_matching":<Boolean_value> , "id":<String_value> , "allow_external_vip_matching":<Boolean_value> , "subnets":[{ "network":<String_value> , "routing_domain":<String_value> }]}]}