Skip to content

routes_stats

Overview

API to get routes information

Version information

Version : v2

URI scheme

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

Tags

  • routes_stats : Operations related to routes_stats

Paths

Get operation for routes_stats

GET /routes_stats

Description

Use this operation to get routes

Responses

HTTP Code Description Schema
200 API Successfully executed routes_stats_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

  • routes_stats

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

cost

A weight to determine Route priority. Lower-cost Routes will be preferred over higher-cost Routes.

Type : integer

eligibility_type

The Route eligibility type

Type : string

eligibility_value

The Route eligibility value

Type : string

eligible

The Route eligibility

Type : string

firewall_zone

The Route firewall zone

Type : string

gateway_ip_addr

The Route Gateway IP Address

Type : string

hit_count

The Route Hit count

Type : integer

neighbour_direct

The Route neighbour direct

Type : string

network_ip_address

Network IP Address

Type : string

protocol

The Routes protocol

Type : string

reachable

The Route reachablity

Type : string

route_type

The Route type. It can be either static or dynamic

Type : string

routes_stats_delete_success_schema

Name Schema
routes_stats
optional
routes_stats

routes_stats

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

routes_stats_post_success_schema

Name Schema
routes_stats
optional
routes_stats

routes_stats

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

routes_stats_put_success_schema

Name Schema
routes_stats
optional
routes_stats

routes_stats

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

routes_stats_response_schema

Type : < routes_stats_response_schema > array

routes_stats_response_schema

Name Schema
cost
optional
cost
eligibility_type
optional
eligibility_type
eligibility_value
optional
eligibility_value
eligible
optional
eligible
firewall_zone
optional
firewall_zone
gateway_ip_addr
optional
gateway_ip_addr
hit_count
optional
hit_count
neighbour_direct
optional
neighbour_direct
network_ip_address
optional
network_ip_address
protocol
optional
protocol
reachable
optional
reachable
route_type
optional
route_type
routing_domain_name
optional
routing_domain_name
service
optional
service
site_ip_address
optional
site_ip_address
site_name
optional
site_name

routing_domain_name

The Routing Domain Name

Type : string

service

The Route Service name

Type : string

site_ip_address

The Route Site IP Address

Type : string

site_name

Site Name

Type : string