Skip to content

rules

Overview

This resource provides Rules Info

Version information

Version : v2

URI scheme

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

Tags

  • rules : Operations related to rules

Paths

Get operation for rules

GET /rules

Description

Use this operation to get Rules details. 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 rules_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

  • rules

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

avg_wan_to_lan_latency

Avg WAN to LAN Latency

Type : string

bytes_dropped

Bytes Dropped

Type : string

dst_ip_address

Dst IP Address

Type : string

dst_port

Destination Port

Type : string

ip_dscp

DSCP IP

Type : string

ip_proto

IP Protocol

Type : string

lan_to_wan_bytes

Lan to WAN bytes

Type : string

lan_to_wan_packets

LAN to WAN Packets

Type : string

last_wan_to_lan_latency

Last WAN to LAN Latency

Type : string

max_wan_to_lan_latency

Max WAN to LAN Latency

Type : string

min_wan_to_lan_latency

Min WAN to LAN Latency

Type : string

num

Rule Number

Type : string

packets_dropped

Packets Dropped

Type : string

routing_domain_name

Routing Domain Name

Type : string

rules_delete_success_schema

Name Schema
rules
optional
rules

rules

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

rules_post_success_schema

Name Schema
rules
optional
rules

rules

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

rules_put_success_schema

Name Schema
rules
optional
rules

rules

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

rules_response_schema

Type : < rules_response_schema > array

rules_response_schema

Name Schema
avg_wan_to_lan_latency
optional
avg_wan_to_lan_latency
bytes_dropped
optional
bytes_dropped
dst_ip_address
optional
dst_ip_address
dst_port
optional
dst_port
ip_dscp
optional
ip_dscp
ip_proto
optional
ip_proto
lan_to_wan_bytes
optional
lan_to_wan_bytes
lan_to_wan_packets
optional
lan_to_wan_packets
last_wan_to_lan_latency
optional
last_wan_to_lan_latency
max_wan_to_lan_latency
optional
max_wan_to_lan_latency
min_wan_to_lan_latency
optional
min_wan_to_lan_latency
num
optional
num
packets_dropped
optional
packets_dropped
routing_domain_name
optional
routing_domain_name
service
optional
service
site
optional
site
src_ip_address
optional
src_ip_address
src_port
optional
src_port
time_since_last_hit
optional
time_since_last_hit
vlan_id
optional
vlan_id
wan_to_lan_bytes
optional
wan_to_lan_bytes
wan_to_lan_jitter
optional
wan_to_lan_jitter
wan_to_lan_kbps
optional
wan_to_lan_kbps
wan_to_lan_packets
optional
wan_to_lan_packets
wan_to_lan_packets_lost
optional
wan_to_lan_packets_lost

service

Service Name

Type : string

site

Site Name

Type : string

src_ip_address

Src IP Address

Type : string

src_port

Src Port

Type : string

time_since_last_hit

Time Since Last Hit

Type : string

vlan_id

VLAN ID

Type : string

wan_to_lan_bytes

WAN to LAN Bytes

Type : string

wan_to_lan_jitter

WAN to LAN Jitter

Type : string

wan_to_lan_kbps

WAN to LAN Bandwidth

Type : string

wan_to_lan_packets

WAN to LAN Packets

Type : string

wan_to_lan_packets_lost

WAN to LAN Packets Lost

Type : string