Get Flows Information (v3.9)

POST 
/v3.9/api/tenants/:tenant_id/monitor/flows

List all the flows information.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Filter for flows

debug_level string

Possible values: [summary, tcp-flags, traffic, all]

The values of the debug levels.

dest_page integer

Dest Page

end_time date

The end time to get the flows information.

filter FlowsFilter

Filters according to the specifications.

app string[]

Filter by app.

element string[]

Filter by element.

flow FlowTupple

Filter by flows information.

destination_ip string[]

Destination Ip

destination_port integer[]

Destination Port

protocol integer

Protocol

source_ip string[]

Source Ip

source_port integer[]

Source Port

flow_type string

Possible values: [local, wan, all]

Filter by flows type.

path string[]

Filter by path.

path_type string[]

Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

Filter by path.

security_policy_destination_zone string[]

Filter by security policy destination zone.

security_policy_rule string[]

Filter by security policy rule.

security_policy_rule_action string

Possible values: [allow, deny, reject]

Filter by policy rule action.

security_policy_source_zone string[]

Filter by security policy source zone.

site string[]

Filter by site.

waninterface string[]

Filter by waninterface.

max_datapoints integer

The max data points.

name string

The description of the flow. Maz size = 128.

page_size integer

Page Size

start_time date

The start time to get the flow information.

view FlowsView

The summary of the flow views.

summary boolean

Summary

Responses

200

Successful Operation

application/json

Schema

Schema

dest_page integer

Dest Page

flows Flows

Flows

debug_level string

The values of the debug levels.

end_time string

The end time to get the flows information.

items FlowSummary[]

The flow summary information.

Array [

app_id string

App Id

bytes_c2s int64

Bytes C2s

bytes_s2c int64

Bytes S2c

destination_ip string

Destination Ip

destination_port integer

Destination Port

fc_app_id string

Fc App Id

flow_action string

Flow Action

flow_direction string

Flow Direction

flow_end_time_ms int64

Flow End Time Ms

flow_start_time_ms int64

Flow Start Time Ms

is_local_traffic boolean

Is Local Traffic

is_v6 boolean

Is V6

lan_to_wan boolean

Lan To Wan

network_policy_id string

Network Policy Id

network_policy_set_id string

Network Policy Set Id

packets_c2s int64

Packets C2s

packets_s2c int64

Packets S2c

path_id string

Path Id

path_id_w2w_egress string

Path Id W2w Egress

path_type string

Path Type

path_type_w2w_egress string

Path Type W2w Egress

policy_id string

Policy Id

priority_policy_id string

Priority Policy Id

priority_policy_set_id string

Priority Policy Set Id

protocol integer

Protocol

sec_policy_actions string[]

Sec Policy Actions

service_endpoint_id string

Service Endpoint Id

source_ip string

Source Ip

source_port integer

Source Port

unknown_domain string

Unknown Domain

user_name string

User Name

vrf_id string

Vrf Id

]

start_time string

The start time to get the flow information.

page_size integer

Page Size

Example (from schema)

{
  "dest_page": 0,
  "flows": {
    "debug_level": "string",
    "end_time": "string",
    "items": [
      {
        "app_id": "string",
        "bytes_c2s": 0,
        "bytes_s2c": 0,
        "destination_ip": "string",
        "destination_port": 0,
        "fc_app_id": "string",
        "flow_action": "string",
        "flow_direction": "string",
        "flow_end_time_ms": 0,
        "flow_start_time_ms": 0,
        "is_local_traffic": true,
        "is_v6": true,
        "lan_to_wan": true,
        "network_policy_id": "string",
        "network_policy_set_id": "string",
        "packets_c2s": 0,
        "packets_s2c": 0,
        "path_id": "string",
        "path_id_w2w_egress": "string",
        "path_type": "string",
        "path_type_w2w_egress": "string",
        "policy_id": "string",
        "priority_policy_id": "string",
        "priority_policy_set_id": "string",
        "protocol": 0,
        "sec_policy_actions": [
          "string"
        ],
        "service_endpoint_id": "string",
        "source_ip": "string",
        "source_port": 0,
        "unknown_domain": "string",
        "user_name": "string",
        "vrf_id": "string"
      }
    ],
    "start_time": "string"
  },
  "page_size": 0
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "EMPTY_REQ_BODY"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "EMPTY_FILTER"
      },
      {
        "code": "PATH_AND_PATH_TYPE_NOT_SUPPORTED"
      },
      {
        "code": "SITE_WITH_PATH_MISSING"
      },
      {
        "code": "SITE_WITH_WANINTERFACE_MISSING"
      },
      {
        "code": "SITE_WITH_ELEMENT_MISSING"
      },
      {
        "code": "SITE_WITH_FLOW_TUPLE_MISSING"
      },
      {
        "code": "INVALID_IP"
      },
      {
        "code": "INVALID_FLOW_TYPE"
      }
    ]
  }
}

Loading...