{ "restSchemaVersion": "1.0", "errors": [ { "error_id": "BAD_REQUEST", "description": "Invalid argument.", "http_status": "400" }, { "error_id": "AUTH_REQUIRED", "description": "Authentication required.", "http_status": "401" }, { "error_id": "AUTH_INVALID_CREDENTIALS", "description": "Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.", "http_status": "401" }, { "error_id": "HTTP_INVALID_METHOD", "description": "Requested method is not available for this resource.", "http_status": "405" }, { "error_id": "INTERNAL_ERROR", "description": "Internal error.", "http_status": "500" } ], "name": "mgmt.flowgateway_analytics", "title": "FlowGateway Analytics Import Stats API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.flowgateway_analytics/1.0", "resources": { "Settings": { "methods": { "Request FlowGateway Analytics Stats using Template Type A": { "description": "Displays available FlowGateway analytics based stats.", "formats": [ "json" ], "httpmethod": "GET", "path": "import_stats", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "FlowGateway Analytics stats request based on last n interval(seconds/minutes/hours/weeks/days/months)", "items": { "description": "Request second/minute/hour based statistics.", "required": false, "properties": { "stats_type": { "description": "flows_per_", "required": true, "type": "string" }, "interval_type": { "description": "seconds/minutes/hours/weeks/days/months", "required": true, "type": "string" }, "time_interval": { "description": " without quotes", "required": true, "type": "number" }, "source_ip": { "description": "Enter IPv4/IPv6 address here or leave this string as empty(includes all source devices).", "required": true, "type": "string" } }, "id": "RequestedStats", "type": "object" }, "id": "RequestedStats", "type": "array", "example": { "stats_type" : "flows_per_minute", "interval_type" : "minutes", "time_interval" : 60, "source_ip" : "10.x.x.x" } }, "response": { "description": "List of FlowGateway analytics based statistics per source device basis or for all source devices.", "items": { "description": "FlowGateway analytics stats per source device or for all source devices.", "required": false, "properties": { "time": { "description": "UTC time", "required": true, "type": "string" }, "source_ip": { "description": "Source device IP address", "required": true, "type": "string" }, "n_flows": { "description": "Total number of flows", "required": true, "type": "number" }, "n_bytes": { "description": "Total number of bytes", "required": true, "type": "number" }, "n_bad_bytes": { "description": "Total number of bad bytes", "required": true, "type": "number" }, "n_packets": { "description": "Total number of packets", "required": true, "type": "number" }, "n_bad_packets": { "description": "Total number of bad packets", "required": true, "type": "number" }, "peak_n_flows": { "description": "Peak value for nflows", "required": true, "type": "string" }, "peak_n_bytes": { "description": "Peak value for nbytes", "required": true, "type": "string" }, "peak_n_packets": { "description": "Peak value for npackets", "required": true, "type": "string" } }, "id": "DisplayStats", "type": "object" }, "id": "DisplayStats", "type": "array", "example": [ { "time": "2024-01-08 22:11:00+00:00", "source_ip": "10.x.x.x", "n_flows": 154, "n_bytes": 8448, "n_bad_bytes": 0, "n_packets": 20, "n_bad_packets": 0, "peak_n_flows": "60", "peak_n_bytes": "3088", "peak_n_packets": "4" }, { "time": "2024-01-08 22:11:00+00:00", "source_ip": "10.x.x.x", "n_flows": 23677, "n_bytes": 1179508, "n_bad_bytes": 0, "n_packets": 827, "n_bad_packets": 0, "peak_n_flows": "1508", "peak_n_bytes": "75088", "peak_n_packets": "52" } ] }, "authorization": "required" }, "Request FlowGateway Analytics Stats using Template Type B": { "description": "Displays available FlowGateway analytics based stats.", "formats": [ "json" ], "httpmethod": "GET", "path": "import_stats", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "FlowGateway Analytics stats request based on start time & end time", "items": { "description": "Request second/minute/hour based statistics.", "required": false, "properties": { "stats_type": { "description": "flows_per_", "required": true, "type": "string" }, "start_time": { "description": "day/month/Year Hour:Minute:Second ex: 23/08/2023 11:36:41", "required": true, "type": "string" }, "end_time": { "description": "day/month/Year Hour:Minute:Second ex: 23/08/2023 13:36:41", "required": true, "type": "string" }, "source_ip": { "description": "Enter IPv4/IPv6 address here or leave this string as empty(includes all source devices).", "required": true, "type": "string" } }, "id": "RequestedStats", "type": "object" }, "id": "RequestedStats", "type": "array", "example": { "stats_type" : "flows_per_minute", "start_time" : "23/08/2023 11:36:41", "end_time" : "23/08/2023 13:36:41", "source_ip" : "" } }, "response": { "description": "List of FlowGateway analytics based statistics per source device basis or for all source devices.", "items": { "description": "FlowGateway analytics stats per source device or for all source devices.", "required": false, "properties": { "time": { "description": "UTC time", "required": true, "type": "string" }, "source_ip": { "description": "Source device IP address", "required": true, "type": "string" }, "n_flows": { "description": "Total number of flows", "required": true, "type": "number" }, "n_bytes": { "description": "Total number of bytes", "required": true, "type": "number" }, "n_bad_bytes": { "description": "Total number of bad bytes", "required": true, "type": "number" }, "n_packets": { "description": "Total number of packets", "required": true, "type": "number" }, "n_bad_packets": { "description": "Total number of bad packets", "required": true, "type": "number" }, "peak_n_flows": { "description": "Peak value for nflows", "required": true, "type": "string" }, "peak_n_bytes": { "description": "Peak value for nbytes.", "required": true, "type": "string" }, "peak_n_packets": { "description": "Peak value for npackets", "required": true, "type": "string" } }, "id": "DisplayStats", "type": "object" }, "id": "DisplayStats", "type": "array", "example": [ { "time": "2024-01-08 22:11:00+00:00", "source_ip": "10.x.x.x", "n_flows": 154, "n_bytes": 8448, "n_bad_bytes": 0, "n_packets": 20, "n_bad_packets": 0, "peak_n_flows": "60", "peak_n_bytes": "3088", "peak_n_packets": "4" }, { "time": "2024-01-08 22:11:00+00:00", "source_ip": "10.x.x.x", "n_flows": 23677, "n_bytes": 1179508, "n_bad_bytes": 0, "n_packets": 827, "n_bad_packets": 0, "peak_n_flows": "1508", "peak_n_bytes": "75088", "peak_n_packets": "52" } ] }, "authorization": "required" }, "Request FlowGateway Analytics Stats using Template Type C": { "description": "Displays available FlowGateway analytics based stats.", "formats": [ "json" ], "httpmethod": "GET", "path": "import_stats", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "FlowGateway Analytics stats request based on epoch start time & end time", "items": { "description": "Request second/minute/hour based statistics.", "required": false, "properties": { "stats_type": { "description": "flows_per_", "required": true, "type": "string" }, "start_time": { "description": "epoch time as an without quotes.", "required": true, "type": "number" }, "end_time": { "description": "epoch time as an without quotes.", "required": true, "type": "number" }, "source_ip": { "description": "Enter IPv4/IPv6 address here or leave this string as empty(includes all source devices).", "required": true, "type": "string" } }, "id": "RequestedStats", "type": "object" }, "id": "RequestedStats", "type": "array", "example": { "stats_type" : "flows_per_minute", "start_time" : 1702580400, "end_time" : 1702584000, "source_ip" : "" } }, "response": { "description": "List of FlowGateway analytics based statistics per source device basis or for all source devices.", "items": { "description": "FlowGateway analytics stats per source device or for all source devices.", "required": false, "properties": { "time": { "description": "UTC time", "required": true, "type": "string" }, "source_ip": { "description": "Source device IP address", "required": true, "type": "string" }, "n_flows": { "description": "Total number of flows", "required": true, "type": "number" }, "n_bytes": { "description": "Total number of bytes", "required": true, "type": "number" }, "n_bad_bytes": { "description": "Total number of bad bytes", "required": true, "type": "number" }, "n_packets": { "description": "Total number of packets", "required": true, "type": "number" }, "n_bad_packets": { "description": "Total number of bad packets", "required": true, "type": "number" }, "peak_n_flows": { "description": "Peak value for nflows", "required": true, "type": "string" }, "peak_n_bytes": { "description": "Peak value for nbytes.", "required": true, "type": "string" }, "peak_n_packets": { "description": "Peak value for npackets", "required": true, "type": "string" } }, "id": "DisplayStats", "type": "object" }, "id": "DisplayStats", "type": "array", "example": [ { "time": "2024-01-08 22:11:00+00:00", "source_ip": "10.x.x.x", "n_flows": 154, "n_bytes": 8448, "n_bad_bytes": 0, "n_packets": 20, "n_bad_packets": 0, "peak_n_flows": "60", "peak_n_bytes": "3088", "peak_n_packets": "4" }, { "time": "2024-01-08 22:11:00+00:00", "source_ip": "10.x.x.x", "n_flows": 23677, "n_bytes": 1179508, "n_bad_bytes": 0, "n_packets": 827, "n_bad_packets": 0, "peak_n_flows": "1508", "peak_n_bytes": "75088", "peak_n_packets": "52" } ] }, "authorization": "required" } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with FlowGateway Product. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\ndata can be accessed, how to configure and clear it.\n

\n\n

\nThe following operations can be performed via the API:\n

\n
    \n
  • Display FlowGateway Analytics based statistics for all client source devices
    • \n
\n\n

\nDetails about REST resources can be found in the Resources\nsection. This overview continues with how to run these API's.\n

\n\n

Authentication

\n\n

\nAll REST requests must be authenticated. The Authentication\nsection of the Common API describes which authentication methods\nare presently supported. \n

\n\n" }