path¶
Overview¶
Paths configuration for virtual paths
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- path : Operations related to path
Paths¶
POST operation for path¶
POST /path
Description¶
Use this operation to add paths
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
path_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | path_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¶
- path
Get operation for path¶
GET /path
Description¶
Use this operation to get the Path configuration for a particular virtual path
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | path_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¶
- path
PUT operation for path¶
PUT /path
Description¶
Use this operation to modify a path
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | path_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¶
- path
DELETE operation for path¶
DELETE /path/{deletePathParam}
Description¶
Use this operation to delete a path
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | path_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¶
- path
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bad_loss_sensitive¶
If Bad Loss Sensitive is set to Enable, Paths will be marked BAD due to loss and will incur a Path scoring penalty. Setting this option to Disable may be useful when the loss of bandwidth is intolerable. Custom settings allow you to specify the percentage of loss over time required to mark a Path BAD.
Type : enum (ENABLE, DISABLE, CUSTOM)
enable_encryption¶
If enabled, packets sent along this Path will be encrypted
Type : boolean
from_site_name¶
Source site for the new path
Type : string
from_wan_link_name¶
Source WAN link for the new path
Type : string
instability_sensitive¶
If you enable Instability Sensitive, latency penalties due to the Path being in a BAD state and other latency spikes are considered in the Path scoring algorithm
Type : boolean
ip_dscp_tagging¶
The DSCP Tag to set in the IP header for Path traffic
Type : enum (ANY, DEFAULT, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)
package_name¶
Package corresponding to the API operation
Type : string
path¶
| Name | Schema |
|---|---|
| bad_loss_sensitive optional |
bad_loss_sensitive |
| enable_encryption optional |
enable_encryption |
| from_site_name optional |
from_site_name |
| from_wan_link_name optional |
from_wan_link_name |
| instability_sensitive optional |
instability_sensitive |
| ip_dscp_tagging optional |
ip_dscp_tagging |
| package_name optional |
package_name |
| reverse_also optional |
reverse_also |
| reverse_tracking_ip_address optional |
reverse_tracking_ip_address |
| silence_period optional |
silence_period |
| static_path optional |
static_path |
| to_site_name optional |
to_site_name |
| to_wan_link_name optional |
to_wan_link_name |
| tracking_ip_address optional |
tracking_ip_address |
| virtual_path_name optional |
virtual_path_name |
path_delete_success_schema¶
| Name | Schema |
|---|---|
| path optional |
path |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
path_post_success_schema¶
| Name | Schema |
|---|---|
| path optional |
path |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
path_put_success_schema¶
| Name | Schema |
|---|---|
| path optional |
path |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
path_request_schema¶
| Name | Schema |
|---|---|
| path optional |
path |
path_response_schema¶
Type : < path_response_schema > array
| Name | Schema |
|---|---|
| bad_loss_sensitive optional |
bad_loss_sensitive |
| enable_encryption optional |
enable_encryption |
| from_site_name optional |
from_site_name |
| from_wan_link_name optional |
from_wan_link_name |
| instability_sensitive optional |
instability_sensitive |
| ip_dscp_tagging optional |
ip_dscp_tagging |
| package_name optional |
package_name |
| reverse_also optional |
reverse_also |
| reverse_tracking_ip_address optional |
reverse_tracking_ip_address |
| silence_period optional |
silence_period |
| static_path optional |
static_path |
| to_site_name optional |
to_site_name |
| to_wan_link_name optional |
to_wan_link_name |
| tracking_ip_address optional |
tracking_ip_address |
| virtual_path_name optional |
virtual_path_name |
reverse_also¶
Add reverse path configuration also
Type : boolean
reverse_tracking_ip_address¶
If Reverse Also is enabled, a virtual IP address on the Path that can be pinged to determine the state of the reverse Path
Type : string
silence_period¶
Specify silence duration before Path state transitions from GOOD to BAD. When not specified, the default is 150ms
Type : enum (500, 750, 1000, 10000, 20000, 30000, 40000, 50000, 60000)
static_path¶
Convert Path, and all other Paths associated by WAN Link, Generated by an Autopath Group, to a Static Path. This action cannot be undone
Type : boolean
to_site_name¶
Destination site for the new path
Type : string
to_wan_link_name¶
Destination WAN Link for the new path
Type : string
tracking_ip_address¶
A virtual IP address on the Path that can be pinged to determine the state of the Path
Type : string
virtual_path_name¶
Name of virtual path to which the path belongs
Type : string