{ "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.flow_forwarding", "title": "Flow Forwarding API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.flow_forwarding/1.0", "resources": { "Settings": { "methods": { "Display Settings": { "description": "Displays flow forwarding & flow forwarding filter settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of flow forwarding and filter current settings.", "items": { "description": "Flow forwarding and filters.", "required": false, "properties": { "dst_ip": { "description": "Destination IP address.", "required": true, "type": "string" }, "dst_port": { "description": "Destination Port.", "required": true, "type": "number" }, "flow_type": { "description": "Flow Type.", "required": true, "type": "string" }, "rewrite_src": { "description": "Overwrite Source.", "required": true, "type": "boolean" }, "router_ip": { "description": "Flow Sources Filter.", "required": true, "items": { "description": "Source IP address.", "required": false, "type": "string" }, "type": "array" } }, "id": "CurrentSetting", "type": "object" }, "id": "CurrentSettings", "type": "array", "example": [ { "dst_ip": "10.1.1.1", "dst_port": 1234, "flow_type": "NetFlow", "rewrite_src": true, "router_ip": [ "10.1.1.4", "10.1.1.5" ] }, { "dst_ip": "10.1.1.2", "dst_port": 2345, "flow_type": "sFlow", "rewrite_src": false, "router_ip": [ "10.1.1.6", "10.1.1.7" ] } ] }, "authorization": "required" }, "Configure Settings": { "description": "Configures flow forwarding & flow forwarding filter settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "List of flow forwarding and filter new settings.", "items": { "description": "Flow forwarding and filters.", "required": false, "properties": { "dst_ip": { "description": "Destination IP address.", "required": true, "type": "string" }, "dst_port": { "description": "Destination Port.", "required": true, "type": "number" }, "flow_type": { "description": "Flow Type.", "required": true, "type": "string" }, "rewrite_src": { "description": "Overwrite Source.", "required": true, "type": "boolean" }, "router_ip": { "description": "Flow Sources Filter.", "required": true, "items": { "description": "Source IP address.", "required": false, "type": "string" }, "type": "array" } }, "id": "NewSetting", "type": "object" }, "id": "NewSettings", "type": "array", "example": [ { "dst_ip": "10.1.1.1", "dst_port": 1234, "flow_type": "NetFlow", "rewrite_src": true, "router_ip": [ "10.1.1.4", "10.1.1.5" ] }, { "dst_ip": "10.1.1.2", "dst_port": 2345, "flow_type": "sFlow", "rewrite_src": false, "router_ip": [ "10.1.1.6", "10.1.1.7" ] } ] }, "authorization": "required" }, "Delete Settings": { "description": "Deletes flow forwarding & flow forwarding filter settings.", "formats": [ "json" ], "httpmethod": "DELETE", "path": "settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "List of Flow Forwarding and filter settings to be deleted.", "items": { "description": "Flow forwarding and filters.", "required": false, "properties": { "dst_ip": { "description": "Destination IP address.", "required": true, "type": "string" }, "dst_port": { "description": "Destination Port.", "required": true, "type": "number" }, "flow_type": { "description": "Flow Type.", "required": true, "type": "string" }, "rewrite_src": { "description": "Overwrite Source.", "required": true, "type": "boolean" }, "router_ip": { "description": "Flow Sources Filter.", "required": true, "items": { "description": "Source IP address.", "required": false, "type": "string" }, "type": "array" } }, "id": "DeleteSetting", "type": "object" }, "id": "DeleteSettings", "type": "array", "example": [ { "dst_ip": "10.1.1.1", "dst_port": 1234, "flow_type": "NetFlow", "rewrite_src": true, "router_ip": [ "10.1.1.4", "10.1.1.5" ] }, { "dst_ip": "10.1.1.2", "dst_port": 2345, "flow_type": "sFlow", "rewrite_src": false, "router_ip": [ "10.1.1.6", "10.1.1.7" ] } ] }, "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\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" }