application_route¶
Overview¶
API to add, modify, delete, and get configuration for application routes
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- application_route : Operations related to application_route
Paths¶
POST operation for application_route¶
POST /application_route
Description¶
Use this operation to add zen branch map entry
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | application_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 |
Produces¶
application/json
Tags¶
- application_route
Get operation for application_route¶
GET /application_route
Description¶
Use this operation to get the list of zen branch map entry
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | application_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¶
- application_route
PUT operation for application_route¶
PUT /application_route
Description¶
Use this operation to modify a zen branch map entry
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
application_route_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | application_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 |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- application_route
DELETE operation for application_route¶
DELETE /application_route/{deletePathParam}
Description¶
Use this operation to delete a zen branch map entry
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | application_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¶
- application_route
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
application_match_name¶
application object name
Type : string
application_route¶
| Name | Schema |
|---|---|
| application_match_name optional |
application_match_name |
| cost optional |
cost |
| eligibility_based_on_gateway optional |
eligibility_based_on_gateway |
| eligibility_based_on_path optional |
eligibility_based_on_path |
| eligibility_based_on_tunnel optional |
eligibility_based_on_tunnel |
| gateway_ip_addr optional |
gateway_ip_addr |
| id optional |
id |
| intranet_service_name optional |
intranet_service_name |
| ipsec_tunnel optional |
ipsec_tunnel |
| next_hop_site optional |
next_hop_site |
| package_name optional |
package_name |
| path optional |
path |
| route_eligibility_from_wan_link optional |
route_eligibility_from_wan_link |
| route_eligibility_to_wan_link optional |
route_eligibility_to_wan_link |
| routing_domain optional |
routing_domain |
| service_type optional |
service_type |
| site_name optional |
site_name |
application_route_delete_success_schema¶
| Name | Schema |
|---|---|
| application_route optional |
application_route |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
application_route_post_success_schema¶
| Name | Schema |
|---|---|
| application_route optional |
application_route |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
application_route_put_success_schema¶
| Name | Schema |
|---|---|
| application_route optional |
application_route |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
application_route_request_schema¶
| Name | Schema |
|---|---|
| application_route optional |
application_route |
application_route_response_schema¶
Type : < application_route_response_schema > array
application_route_response_schema
| Name | Schema |
|---|---|
| application_match_name optional |
application_match_name |
| cost optional |
cost |
| eligibility_based_on_gateway optional |
eligibility_based_on_gateway |
| eligibility_based_on_path optional |
eligibility_based_on_path |
| eligibility_based_on_tunnel optional |
eligibility_based_on_tunnel |
| gateway_ip_addr optional |
gateway_ip_addr |
| id optional |
id |
| intranet_service_name optional |
intranet_service_name |
| ipsec_tunnel optional |
ipsec_tunnel |
| next_hop_site optional |
next_hop_site |
| package_name optional |
package_name |
| path optional |
path |
| route_eligibility_from_wan_link optional |
route_eligibility_from_wan_link |
| route_eligibility_to_wan_link optional |
route_eligibility_to_wan_link |
| routing_domain optional |
routing_domain |
| service_type optional |
service_type |
| site_name optional |
site_name |
cost¶
cost of route
Type : integer
eligibility_based_on_gateway¶
route eligibility on gateway
Type : string
eligibility_based_on_path¶
route eligibility based on path
Type : string
eligibility_based_on_tunnel¶
route eligibility on tunnel
Type : string
gateway_ip_addr¶
gateway ip address
Type : string
id¶
Auto-generated ID. Use this ID to modify or delete a zen_branch_map
Type : integer
intranet_service_name¶
intranet service name
Type : string
ipsec_tunnel¶
LAN Ipsec tunnel name
Type : string
next_hop_site¶
next hop site name
Type : string
package_name¶
Config package name using which the application route API operation should be performed.
Type : string
path¶
Path from which to determine Route eligibility. Path should be given when eligibilty_based_on_path is set to true
Type : string
route_eligibility_from_wan_link¶
route eligibility from wanlink
Type : string
route_eligibility_to_wan_link¶
route eligibility to wanlink
Type : string
routing_domain¶
routing domain
Type : string
service_type¶
service type
Type : string
site_name¶
Sitename
Type : string