Skip to content

tcptermflows

Overview

This resource provides details about TCP Terminated flows

Version information

Version : v2

URI scheme

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

Tags

  • tcptermflows : Operations related to tcptermflows

Paths

Get operation for tcptermflows

GET /tcptermflows

Description

Use this operation to get TCP Termination flows. Filters are supported for this API. max_stats filter is available as an additional option to filter the flow count(50/100/1000). Refer Getting Started Guide where filtering is explained via example of flow summary with max stats filter for monitoring API. Pagination is not supported for this API

Responses

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

  • tcptermflows

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

age

How long ago this flow was created in milliseconds

Type : string

bytes_pending_to_LAN

Number of bytes currently buffered to send to the LAN for this flow

Type : string

bytes_pending_to_WAN

Number of bytes currently buffered to send to the WAN for this flow

Type : string

dest_ip

Destination IP Address for packets on this flow

Type : string

dest_port

Destination Port for packets on this flow

Type : string

from_wan_kbps

WAN To LAN kilobits per seconds

Type : string

ipp

IP Protocol number for packets on this flow

Type : string

src_ip

Source IP Address for packets on this flow

Type : string

src_port

Source Port for packets on this flow

Type : string

state

Current State of this flow

Type : string

tcptermflows_delete_success_schema

Name Schema
tcptermflows
optional
tcptermflows

tcptermflows

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

tcptermflows_post_success_schema

Name Schema
tcptermflows
optional
tcptermflows

tcptermflows

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

tcptermflows_put_success_schema

Name Schema
tcptermflows
optional
tcptermflows

tcptermflows

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

tcptermflows_response_schema

Type : < tcptermflows_response_schema > array

tcptermflows_response_schema

Name Schema
age
optional
age
bytes_pending_to_LAN
optional
bytes_pending_to_LAN
bytes_pending_to_WAN
optional
bytes_pending_to_WAN
dest_ip
optional
dest_ip
dest_port
optional
dest_port
from_wan_kbps
optional
from_wan_kbps
ipp
optional
ipp
src_ip
optional
src_ip
src_port
optional
src_port
state
optional
state
to_wan_kbps
optional
to_wan_kbps

to_wan_kbps

LAN To WAN kilobits per seconds

Type : string