paths

paths

Monitoring for This resource provides details of all the paths in Appliance resource.

Read/write properties

Read only properties

path_service_state <String>

Path Service State.

to_link <String>

Name of the Path(To Link).

path_service_type <String>

Path Service Type.

bandwidth <Float>

Path's Bandwidth in kbps.

packet_loss <Float>

Path's Packet Loss.

path_state <String>

Path State.

jitter <Integer>

Path's Jitter value.

congestion <String>

Path's congestion state.

bowt <Integer>

Best One Way Time Latency.

from_link <String>

Name of the Path(From Link).

mtu <Integer>

Maximum Transferable Unit.

Operations

get (all)

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/monitor/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

HTTP Method: GET

Response Payload: JSON

{"paths":[{ "path_service_state":<String_value>

, "to_link":<String_value> , "path_service_type":<String_value> , "bandwidth":<Float_value> , "packet_loss":<Float_value> , "path_state":<String_value> , "jitter":<Integer_value> , "congestion":<String_value> , "bowt":<Integer_value> , "from_link":<String_value> , "mtu":<Integer_value> }]}

Was this article helpful?