{ "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.netprofiler_export", "title": "NetProfiler Export API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.netprofiler_export/1.0", "resources": { "Settings": { "methods": { "Display Settings": { "description": "Displays Netprofiler export settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description":"Settings", "type": "object", "properties": { "sync_src_ipaddr": { "type": "string", "description": "Specify NetProfiler IP Address for synchronization of Ports and Application Definitions" }, "asm_portal_ipaddr": { "type": "string", "description": "Specify NetProfiler IP Address to send ASM analysis" }, "enable_flow_buffering": { "type": "string", "description": "Enable Flow buffering for offline NetProfilers ? Values : ('true'/'false') " }, "export_ipaddrs": { "type": "array", "items": { "type": "object", "properties": { "netprofiler_ipaddr": { "type": "string", "description":"Specify the target NetProfiler by entering the IP address of the management interface for an NetExpress or Standard NetProfiler, or the address of the Analysis Module for an Enterprise NetProfiler." }, "filter_ipaddrs": { "type": "array", "description":"Enter a comma-separated list of device IP addresses whose traffic is to be sent to the NetProfiler. Leave the Flow Sources field empty if the Flow Gateway is to send all flow data to the specified NetProfiler.", "items": { "type": "string" } } }, "required": [ "netprofiler_ipaddr", "filter_ipaddrs" ] } } }, "required": [ "sync_src_ipaddr", "asm_portal_ipaddr", "enable_flow_buffering", "export_ipaddrs" ], "example":{ "sync_src_ipaddr": "192.1.1.99", "asm_portal_ipaddr": "192.1.1.99", "enable_flow_buffering": "true", "export_ipaddrs": [ { "netprofiler_ipaddr": "192.1.1.1", "filter_ipaddrs": [ "1.1.1.1", "1.1.1.2" ] }, { "netprofiler_ipaddr": "192.1.1.99", "filter_ipaddrs": [ "1.1.1.1", "1.1.1.2" ] } ] } }, "authorization": "required" }, "Configure Settings": { "description": "Configure Netprofiler export settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description":"Settings", "type": "object", "properties": { "sync_src_ipaddr": { "type": "string", "description": "Specify NetProfiler IP Address for synchronization of Ports and Application Definitions" }, "asm_portal_ipaddr": { "type": "string", "description": "Specify NetProfiler IP Address to send ASM analysis" }, "enable_flow_buffering": { "type": "string", "description": "Enable Flow buffering for offline NetProfilers ? Values : ('true'/'false') " }, "export_ipaddrs": { "type": "array", "items": { "type": "object", "properties": { "netprofiler_ipaddr": { "type": "string", "description":"Specify the target NetProfiler by entering the IP address of the management interface for an NetExpress or Standard NetProfiler, or the address of the Analysis Module for an Enterprise NetProfiler." }, "filter_ipaddrs": { "type": "array", "description":"Enter a comma-separated list of device IP addresses whose traffic is to be sent to the NetProfiler. Leave the Flow Sources field empty if the Flow Gateway is to send all flow data to the specified NetProfiler.", "items": { "type": "string" } } }, "required": [ "netprofiler_ipaddr", "filter_ipaddrs" ] } } }, "required": [ "sync_src_ipaddr", "asm_portal_ipaddr", "enable_flow_buffering", "export_ipaddrs" ], "example":{ "sync_src_ipaddr": "192.1.1.99", "asm_portal_ipaddr": "192.1.1.99", "enable_flow_buffering": "true", "export_ipaddrs": [ { "netprofiler_ipaddr": "192.1.1.1", "filter_ipaddrs": [ "1.1.1.1", "1.1.1.2" ] }, { "netprofiler_ipaddr": "192.1.1.99", "filter_ipaddrs": [ "1.1.1.1", "1.1.1.2" ] } ] } }, "authorization": "required" }, "Delete netprofilers": { "description": "Displays Netprofiler export settings.", "formats": [ "json" ], "httpmethod": "DELETE", "path": "settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "type": "object", "properties": { "netprofilers": { "type": "array", "description":"list of netprofilers IPs to delete from settings.", "items": { "type": "string" } } }, "required": [ "netprofilers" ], "example":{ "netprofilers":["192.1.1.99"] } }, "authorization": "required" } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with Riverbed SteelCentral 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 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" }