regions¶
Overview¶
This resource can be used to get the region discovery configuration.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- regions : Operations related to regions
Paths¶
Get operation for regions¶
GET /regions
Description¶
Use this operation to get the regions discovery configuration.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | regions_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¶
- regions
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
collector_ip¶
The IP address of the collector configured to work with the region
Type : string
region_control_node_ip¶
The primary region control node ip address
Type : string
region_discovery_status¶
The status of discovery by Collector for the region appliances
Type : string
region_name¶
The region name
Type : string
regions_delete_success_schema¶
| Name | Schema |
|---|---|
| regions optional |
regions |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
regions_post_success_schema¶
| Name | Schema |
|---|---|
| regions optional |
regions |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
regions_put_success_schema¶
| Name | Schema |
|---|---|
| regions optional |
regions |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
regions_response_schema¶
Type : < regions_response_schema > array
| Name | Schema |
|---|---|
| collector_ip optional |
collector_ip |
| region_control_node_ip optional |
region_control_node_ip |
| region_discovery_status optional |
region_discovery_status |
| region_name optional |
region_name |