routes¶
Overview¶
API to add, delete, get, modify routes
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- routes : Operations related to routes
Paths¶
POST operation for routes¶
POST /routes
Description¶
Use this operation to add routes
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | routes_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¶
- routes
Get operation for routes¶
GET /routes
Description¶
Use this operation to get routes
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | routes_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¶
- routes
PUT operation for routes¶
PUT /routes
Description¶
Use this operation to modify routes
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
routes_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | routes_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¶
- routes
DELETE operation for routes¶
DELETE /routes/{deletePathParam}
Description¶
Use this operation to delete 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 | routes_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¶
- routes
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
cost¶
A weight to determine Route priority. Lower-cost Routes will be preferred over higher-cost Routes.
Type : integer
eligibility_based_on_gateway¶
If enabled, the Route will not receive traffic when the Gateway is unreachable
Type : boolean
eligibility_based_on_path¶
If enabled, the Route will not receive traffic when the selected Path is down
Type : boolean
eligibility_based_on_tunnel¶
If enabled, the Route will not receive traffic when the associated Tunnel is unreachable
Type : boolean
export_route¶
If enabled, this route will be exported to other connected Sites. Intranet and Internet routes will only be exported when WAN-to-WAN forwarding is also enabled
Type : boolean
gateway_ip_addr¶
Gateway. For GRE tunnel route, this must be in the tunnel's subnet
Type : string
id¶
Auto-generated ID to uniquely identify Routes
Type : integer
ipsec_tunnel¶
The IPsec Tunnel to use for this Route
Type : string
network_ip_address¶
Network IP Address
Type : string
next_hop_site¶
The remote Site to which Virtual Path packets will be directed
Type : string
package_name¶
Config package name using which the site 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
routes¶
| Name | Schema |
|---|---|
| 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 |
| export_route optional |
export_route |
| gateway_ip_addr optional |
gateway_ip_addr |
| id optional |
id |
| ipsec_tunnel optional |
ipsec_tunnel |
| network_ip_address optional |
network_ip_address |
| next_hop_site optional |
next_hop_site |
| package_name optional |
package_name |
| path optional |
path |
| routing_domain optional |
routing_domain |
| service_name optional |
service_name |
| service_type optional |
service_type |
| site_name optional |
site_name |
| summary_route optional |
summary_route |
routes_delete_success_schema¶
| Name | Schema |
|---|---|
| routes optional |
routes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
routes_post_success_schema¶
| Name | Schema |
|---|---|
| routes optional |
routes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
routes_put_success_schema¶
| Name | Schema |
|---|---|
| routes optional |
routes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
routes_request_schema¶
| Name | Schema |
|---|---|
| routes optional |
routes |
routes_response_schema¶
Type : < routes_response_schema > array
| Name | Schema |
|---|---|
| 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 |
| export_route optional |
export_route |
| gateway_ip_addr optional |
gateway_ip_addr |
| id optional |
id |
| ipsec_tunnel optional |
ipsec_tunnel |
| network_ip_address optional |
network_ip_address |
| next_hop_site optional |
next_hop_site |
| package_name optional |
package_name |
| path optional |
path |
| routing_domain optional |
routing_domain |
| service_name optional |
service_name |
| service_type optional |
service_type |
| site_name optional |
site_name |
| summary_route optional |
summary_route |
routing_domain¶
One of the configured routing domains
Type : string
service_name¶
Service name
Type : string
service_type¶
Service Type
Type : enum (virtual_path, internet, intranet, passthrough, local, lan_gre_tunnel, lan_ipsec_tunnel, discard)
site_name¶
Site Name
Type : string
summary_route¶
If enabled, this route will be advertised to other connected instead of individual summarized routes
Type : boolean