virtual_path_services¶
Overview¶
This resource provides details of all the virtual path services in Appliance
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- virtual_path_services : Operations related to virtual_path_services
Paths¶
Get operation for virtual_path_services¶
GET /virtual_path_services
Description¶
Use this operation to get Virtual Paths Service statistics. Filter and Pagination are supported for this API. Refer Getting Started Guide where filtering and pagination is explained via example of application monitoring API
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | virtual_path_services_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¶
- virtual_path_services
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
best_jitter¶
best Jitter value for the virtual path service
Type : integer
bowt¶
Best One Way Time Latency
Type : integer
from_site¶
Name of the Virtual Path Service(From Site)
Type : string
ipsec_tunnel_state¶
IPsec tunnel state
Type : string
mtu¶
Maximum Transferable Unit
Type : string
receive_rate¶
receive rate for the virtual path service
Type : number
since_created¶
Time since creation
Type : integer
state¶
State of the virtual path service
Type : enum (UNDEFINED, DISABLED, DEAD, BAD, GOOD)
to_site¶
Name of the Virtual Path Service(To Site)
Type : string
virtual_path_service_type¶
Virtual Path Service Type
Type : enum (Static, Dynamic)
virtual_path_services_delete_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_services optional |
virtual_path_services |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
virtual_path_services_post_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_services optional |
virtual_path_services |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
virtual_path_services_put_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_services optional |
virtual_path_services |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
virtual_path_services_response_schema¶
Type : < virtual_path_services_response_schema > array
virtual_path_services_response_schema
| Name | Schema |
|---|---|
| best_jitter optional |
best_jitter |
| bowt optional |
bowt |
| from_site optional |
from_site |
| ipsec_tunnel_state optional |
ipsec_tunnel_state |
| mtu optional |
mtu |
| receive_rate optional |
receive_rate |
| since_created optional |
since_created |
| state optional |
state |
| to_site optional |
to_site |
| virtual_path_service_type optional |
virtual_path_service_type |
| wan_link_congested optional |
wan_link_congested |
| worst_jitter optional |
worst_jitter |
wan_link_congested¶
WAN Link congested or not
Type : enum (YES, NO)
worst_jitter¶
Worst Jitter value for the virtual path service
Type : integer