dynamic_route¶
Overview¶
API to get/add/delete the dynamic route
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- dynamic_route : Operations related to dynamic_route
Paths¶
POST operation for dynamic_route¶
POST /dynamic_route
Description¶
Use this operation to add dynamic route IP Information and cost of the routes
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
dynamic_route_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | dynamic_route_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 |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- dynamic_route
Get operation for dynamic_route¶
GET /dynamic_route
Description¶
Use this operation to get dynamic route IP Information and cost of the routes
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | dynamic_route_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¶
- dynamic_route
PUT operation for dynamic_route¶
PUT /dynamic_route
Description¶
Use this operation to modify dynamic route IP Information and cost of the routes
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | dynamic_route_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 |
Produces¶
application/json
Tags¶
- dynamic_route
DELETE operation for dynamic_route¶
DELETE /dynamic_route/{deletePathParam}
Description¶
Use this operation to delete dynamic route IP Information and cost of the routes
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | dynamic_route_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¶
- dynamic_route
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
cost¶
Cost of the Route
Type : integer
dynamic_route¶
| Name | Schema |
|---|---|
| cost optional |
cost |
| routeip optional |
routeip |
| subnet optional |
subnet |
dynamic_route_delete_success_schema¶
| Name | Schema |
|---|---|
| dynamic_route optional |
dynamic_route |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
dynamic_route_post_success_schema¶
| Name | Schema |
|---|---|
| dynamic_route optional |
dynamic_route |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
dynamic_route_put_success_schema¶
| Name | Schema |
|---|---|
| dynamic_route optional |
dynamic_route |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
dynamic_route_request_schema¶
| Name | Schema |
|---|---|
| dynamic_route optional |
dynamic_route |
dynamic_route_response_schema¶
Type : < dynamic_route_response_schema > array
| Name | Schema |
|---|---|
| cost optional |
cost |
| routeip optional |
routeip |
| subnet optional |
subnet |
routeip¶
Route IP Address
Type : string
subnet¶
Route IP Subnet Information
Type : integer