paths¶
Overview¶
This resource provides details of all the paths in Appliance
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- paths : Operations related to paths
Paths¶
Get operation for paths¶
GET /paths
Description¶
Use this operation to get Paths Summary. 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 | paths_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¶
- paths
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bandwidth¶
Path's Bandwidth in kbps
Type : number
bowt¶
Best One Way Time Latency
Type : integer
congestion¶
Path's congestion state
Type : enum (YES, NO)
from_link¶
Name of the Path(From Link)
Type : string
jitter¶
Path's Jitter value
Type : integer
mtu¶
Maximum Transferable Unit
Type : integer
packet_loss¶
Path's Packet Loss
Type : number
path_service_state¶
Path Service State
Type : enum (UNDEFINED, DISABLED, DEAD, BAD, GOOD)
path_service_type¶
Path Service Type
Type : enum (Static, Dynamic)
path_state¶
Path State
Type : enum (UNDEFINED, DISABLED, DEAD, BAD, GOOD)
paths_delete_success_schema¶
| Name | Schema |
|---|---|
| paths optional |
paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
paths_post_success_schema¶
| Name | Schema |
|---|---|
| paths optional |
paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
paths_put_success_schema¶
| Name | Schema |
|---|---|
| paths optional |
paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
paths_response_schema¶
Type : < paths_response_schema > array
| Name | Schema |
|---|---|
| bandwidth optional |
bandwidth |
| bowt optional |
bowt |
| congestion optional |
congestion |
| from_link optional |
from_link |
| jitter optional |
jitter |
| mtu optional |
mtu |
| packet_loss optional |
packet_loss |
| path_service_state optional |
path_service_state |
| path_service_type optional |
path_service_type |
| path_state optional |
path_state |
| to_link optional |
to_link |
to_link¶
Name of the Path(To Link)
Type : string