Skip to content

paths_detailed

Overview

This resource provides detailed summary of all the paths in Appliance

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP

Tags

  • paths_detailed : Operations related to paths_detailed

Paths

Get operation for paths_detailed

GET /paths_detailed

Description

Use this operation to get detailed 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_detailed_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_detailed

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)

destination_port

Destination Port Number

Type : integer

duration

Duration of Path in Current State (in seconds)

Type : string

Name of the Path(From Link)

Type : string

jitter

Path's Jitter value

Type : integer

mtu

Maximum Transferable Unit

Type : string

packet_loss

Path's Packet Loss Percentage

Type : number

packets_ooo

Packets Out of Order

Type : integer

packets_received

Packets Received

Type : integer

path_service_state

Virtual Path Service State

Type : enum (UNDEFINED, DISABLED, DEAD, BAD, GOOD)

path_service_type

Virtual Path Service Type

Type : enum (Static, Dynamic)

path_state

Path State

Type : enum (UNDEFINED, DISABLED, DEAD, BAD, GOOD)

path_state_reason

Reason of Path State

Type : enum (SILENCE, LOSS, PEER, GATEWAY, N/A)

paths_detailed_delete_success_schema

Name Schema
paths_detailed
optional
paths_detailed

paths_detailed

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

paths_detailed_post_success_schema

Name Schema
paths_detailed
optional
paths_detailed

paths_detailed

Name Description Schema
message
optional
Example : "resource added succesfully" string

paths_detailed_put_success_schema

Name Schema
paths_detailed
optional
paths_detailed

paths_detailed

Name Description Schema
message
optional
Example : "resource modified succesfully" string

paths_detailed_response_schema

Type : < paths_detailed_response_schema > array

paths_detailed_response_schema

Name Schema
bandwidth
optional
bandwidth
bowt
optional
bowt
congestion
optional
congestion
destination_port
optional
destination_port
duration
optional
duration
from_link
optional
from_link
jitter
optional
jitter
mtu
optional
mtu
packet_loss
optional
packet_loss
packets_ooo
optional
packets_ooo
packets_received
optional
packets_received
path_service_state
optional
path_service_state
path_service_type
optional
path_service_type
path_state
optional
path_state
path_state_reason
optional
path_state_reason
source_port
optional
source_port
to_link
optional
to_link

source_port

Source Port Number

Type : integer

Name of the Path(To Link)

Type : string