Skip to content

observed_protocols

Overview

This resource provides details of all the observed protocols.

Version information

Version : v2

URI scheme

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

Tags

  • observed_protocols : Operations related to observed_protocols

Paths

Get operation for observed_protocols

GET /observed_protocols

Description

Use this operation to get Observed Protocol statistics. 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 observed_protocols_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

  • observed_protocols

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

observed_protocols_delete_success_schema

Name Schema
observed_protocols
optional
observed_protocols

observed_protocols

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

observed_protocols_post_success_schema

Name Schema
observed_protocols
optional
observed_protocols

observed_protocols

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

observed_protocols_put_success_schema

Name Schema
observed_protocols
optional
observed_protocols

observed_protocols

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

observed_protocols_response_schema

Type : < observed_protocols_response_schema > array

observed_protocols_response_schema

Name Schema
port
optional
port
protocol
optional
protocol
rule
optional
rule
rule_group
optional
rule_group
service_instance
optional
service_instance
service_type
optional
service_type
wan_egress_bytes
optional
wan_egress_bytes
wan_egress_kbps
optional
wan_egress_kbps
wan_egress_packets
optional
wan_egress_packets
wan_ingress_bytes
optional
wan_ingress_bytes
wan_ingress_kbps
optional
wan_ingress_kbps
wan_ingress_packets
optional
wan_ingress_packets

port

Port

Type : string

protocol

Name of the protocol

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

rule

Name of the Rule

Type : string

rule_group

Name of the rule group

Type : string

service_instance

Service instance

Type : integer

service_type

Service type

Type : string

wan_egress_bytes

Bytes transfered WAN to LAN

Type : integer

wan_egress_kbps

Transfer rate WAN to LAN kbps

Type : number

wan_egress_packets

Packets transfered WAN to LAN

Type : integer

wan_ingress_bytes

Bytes transfered LAN to WAN

Type : integer

wan_ingress_kbps

Transfer rate LAN to WAN kbps

Type : number

wan_ingress_packets

Packets transfered LAN to WAN

Type : integer