region¶
Overview¶
API to add, modify, delete, and get regions
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- region : Operations related to region
Paths¶
POST operation for region¶
POST /region
Description¶
Use this operation to add a region
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | region_post_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- region
Get operation for region¶
GET /region
Description¶
Use this operation to get the regions
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | region_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- region
PUT operation for region¶
PUT /region
Description¶
Use this operation to modify a region
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
region_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | region_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- region
DELETE operation for region¶
DELETE /region/{deletePathParam}
Description¶
Use this operation to delete a region. This operation also deletes all the sites in the region
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | region_delete_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- region
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
allow_external_vip_matching¶
When enabled, non-private Virtual IP Addresses from other regions will be allowed to match the configured subnets
Type : boolean
force_internal_vip_matching¶
When enabled, all non-private Virtual IP Addressess in the Region will be forced to match the configured subnets
Type : boolean
id¶
Config package name using which the region API operation should be performed.
Type : string
is_default¶
If enabled, the Region will be used as the default Region for the network
Type : boolean
package_name¶
Config package name using which the region API operation should be performed.
Type : string
region¶
| Name | Schema |
|---|---|
| allow_external_vip_matching optional |
allow_external_vip_matching |
| force_internal_vip_matching optional |
force_internal_vip_matching |
| id optional |
id |
| is_default optional |
is_default |
| package_name optional |
package_name |
| region_description optional |
region_description |
| region_name optional |
region_name |
| subnets optional |
subnets |
region_delete_success_schema¶
| Name | Schema |
|---|---|
| region optional |
region |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
region_description¶
Region description
Type : string
region_name¶
Region Name
Type : string
region_post_success_schema¶
| Name | Schema |
|---|---|
| region optional |
region |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
region_put_success_schema¶
| Name | Schema |
|---|---|
| region optional |
region |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
region_request_schema¶
| Name | Schema |
|---|---|
| region optional |
region |
region_response_schema¶
Type : < region_response_schema > array
| Name | Schema |
|---|---|
| allow_external_vip_matching optional |
allow_external_vip_matching |
| force_internal_vip_matching optional |
force_internal_vip_matching |
| id optional |
id |
| is_default optional |
is_default |
| package_name optional |
package_name |
| region_description optional |
region_description |
| region_name optional |
region_name |
| subnets optional |
subnets |
subnets¶
Subnets for this region
Type : < subnets > array
| Name | Description | Schema |
|---|---|---|
| network optional |
The IP address and mask for the subnet | string |
| routing_domain optional |
The routing domain | string |