{ "restSchemaVersion": "1.0", "errors": [ { "error_id": "PARTIAL_CONTENT", "description": "Operation was partially successfull.", "http_status": "206" }, { "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": "INTERNAL_ERROR", "description": "Internal error.", "http_status": "500" } ], "name": "mgmt.netprofiler_policies", "title": "Policies API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.netprofiler_policies/1.0", "resources": { "HealthPolicies": { "methods": { "Display Policy Settings": { "description": "Displays Health Policies Settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "health_policies", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Displays Health Policies Current Settings.", "type": "object", "properties": { "Health Policies": { "description": "Health Policies.", "type": "object", "properties": { "Data Source Problem": { "description": "Data Source Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Data Source Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "Displays High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Displays Data Source Problem Advanced Settings.", "type": "object", "properties": { "Disconnects": { "description": "Displays Data Source Disconnects Settings is enabled or not.", "type": "string" }, "Protocol Violations": { "description": "Displays Data Source Protocol Violations Settings is enabled or not.", "type": "string" }, "Silent Interfaces": { "description": "Displays if Silent Interfaces Settings is enabled or not.", "type": "string" }, "Interface Silence Tolerance": { "description": "Displays value for Interface Silence Tolerance.", "type": "string" }, "Sensor Application Matching Problems": { "description": "Displays if Sensor Application Matching Problems Settings is enabled or not.", "type": "string" } }, "required": [ "Disconnects", "Protocol Violations", "Silent Interfaces", "Interface Silence Tolerance", "Sensor Application Matching Problems" ] } }, "required": [ "Enabled", "High Alerts", "Advanced Settings" ] }, "Hardware Problem": { "description": "Hardware Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Hardware Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "Displays High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Displays Hardware Problem Advanced Settings.", "type": "object", "properties": { "Fan Failure": { "description": "Displays Fan Failure setting is enabled or not.", "type": "string" }, "Power Failure": { "description": "Displays Power Failure setting is enabled or not.", "type": "string" }, "High Temperature": { "description": "Displays High Temperature setting is enabled or not.", "type": "string" }, "CPU Issue": { "description": "Displays CPU Issue setting is enabled or not.", "type": "string" }, "Memory Issue": { "description": "Displays Memory Issue setting is enabled or not.", "type": "string" } }, "required": [ "Fan Failure", "Power Failure", "High Temperature", "CPU Issue", "Memory Issue" ] } }, "required": [ "Enabled", "High Alerts", "Advanced Settings" ] }, "Module Problem": { "description": "Module Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Module Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "Displays High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Displays Module Problem Advanced Settings.", "type": "object", "properties": { "Module Failure": { "description": "Displays Module Failure setting is enabled or not.", "type": "string" }, "Process Failure": { "description": "Displays Process Failure setting is enabled or not.", "type": "string" }, "Time Unsynchronized": { "description": "Displays Time Unsynchronized setting is enabled or not.", "type": "string" }, "System Process Crashed": { "description": "Displays System Process Crashed setting is enabled or not.", "type": "string" }, "Flow Limit Breached": { "description": "Displays Flow Limit Breached setting is enabled or not.", "type": "string" } }, "required": [ "Module Failure", "Process Failure", "Time Unsynchronized", "System Process Crashed", "Flow Limit Breached" ] } }, "required": [ "Enabled", "High Alerts", "Advanced Settings" ] }, "Storage Problem": { "description": "Storage Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Storage Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "Displays High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Advanced are unavailable by default and will displayed as NA.", "type": "string" } }, "required": [ "Enabled", "High Alerts", "Advanced Settings" ] } }, "required": [ "Data Source Problem", "Hardware Problem", "Module Problem", "Storage Problem" ] } }, "required": [ "Health Policies" ], "example": { "Health Policies": { "Data Source Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": { "Disconnects": "true", "Protocol Violations": "false", "Silent Interfaces": "true", "Interface Silence Tolerance": "2", "Sensor Application Matching Problems": "true" } }, "Hardware Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": { "Fan Failure": "true", "Power Failure": "true", "High Temperature": "true", "CPU Issue": "true", "Memory Issue": "true" } }, "Module Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": { "Module Failure": "true", "Process Failure": "true", "Time Unsynchronized": "true", "System Process Crashed": "true", "Flow Limit Breached": "true" } }, "Storage Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": "NA" } } } }, "authorization": "required" }, "Configure Policy Settings": { "description": "Configure Health Policies Settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "health_policies", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "Configures Health Policies With New Settings.", "type": "object", "properties": { "Health Policies": { "description": "Health Policies.", "type": "object", "properties": { "Data Source Problem": { "description": "Data Source Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Data Source Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Configure Data Source Problem Advanced Settings.", "type": "object", "properties": { "Disconnects": { "description": "Configure Data Source Disconnects Settings.", "type": "string" }, "Protocol Violations": { "description": "Configure Data Source Protocol Violations Settings.", "type": "string" }, "Silent Interfaces": { "description": "Configure Silent Interfaces Settings.", "type": "string" }, "Interface Silence Tolerance": { "description": "Configure value for Interface Silence Tolerance.", "type": "string" }, "Sensor Application Matching Problems": { "description": "Configure Sensor Application Matching Problems Settings.", "type": "string" } }, "required": [ "Disconnects", "Protocol Violations", "Silent Interfaces", "Interface Silence Tolerance", "Sensor Application Matching Problems" ] } }, "required": [ "Advanced Settings" ] }, "Hardware Problem": { "description": "Hardware Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Hardware Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Configure Hardware Problem Advanced Settings.", "type": "object", "properties": { "Fan Failure": { "description": "Configure Fan Failure setting.", "type": "string" }, "Power Failure": { "description": "Configure Power Failure setting.", "type": "string" }, "High Temperature": { "description": "Configure High Temperature setting.", "type": "string" }, "CPU Issue": { "description": "Configure CPU Issue setting.", "type": "string" }, "Memory Issue": { "description": "Configure Memory Issue setting.", "type": "string" } }, "required": [ "Fan Failure", "Power Failure", "High Temperature", "CPU Issue", "Memory Issue" ] } }, "required": [ "Advanced Settings" ] }, "Module Problem": { "description": "Module Problem Policy.", "type": "object", "properties": { "Enabled": { "description": "Displays if Module Problem Settings is enabled or not.", "type": "string" }, "High Alerts": { "description": "High alerts count.", "type": "number" }, "Advanced Settings": { "description": "Configure Module Problem Advanced Settings.", "type": "object", "properties": { "Module Failure": { "description": "Configure Module Failure setting.", "type": "string" }, "Process Failure": { "description": "Configure Process Failure setting.", "type": "string" }, "Time Unsynchronized": { "description": "Configure Time Unsynchronized setting.", "type": "string" }, "System Process Crashed": { "description": "Configure System Process Crashed setting.", "type": "string" }, "Flow Limit Breached": { "description": "Configure Flow Limit Breached setting.", "type": "string" } }, "required": [ "Module Failure", "Process Failure", "Time Unsynchronized", "System Process Crashed", "Flow Limit Breached" ] } }, "required": [ "Advanced Settings" ] } }, "required": [ "Data Source Problem", "Hardware Problem", "Module Problem" ] } }, "required": [ "Health Policies" ], "example": { "Health Policies": { "Data Source Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": { "Disconnects": "true", "Protocol Violations": "true", "Silent Interfaces": "true", "Interface Silence Tolerance": "2", "Sensor Application Matching Problems": "true" } }, "Hardware Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": { "Fan Failure": "true", "Power Failure": "true", "High Temperature": "true", "CPU Issue": "true", "Memory Issue": "true" } }, "Module Problem": { "Enabled": "True", "High Alerts": 0, "Advanced Settings": { "Module Failure": "true", "Process Failure": "true", "Time Unsynchronized": "true", "System Process Crashed": "true", "Flow Limit Breached": "true" } } } } }, "authorization": "required" } } }, "Perf/AvailPolicies": { "methods": { "Display Perf/Avail Policies": { "description": "Display current Performance and Availability Policies.", "formats": [ "json" ], "httpmethod": "GET", "path": "perf_availability", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Current Performance and Availability Policies.", "items": { "description": "Performance and Availability Policy", "required": false, "properties": { "policy_type": { "description": "Type of this policy. This is assigned by the system and can't be changed", "required": false, "type": "number" }, "event_name": { "description": "Name of this policy. Name given to the policy by the user when it is created.", "required": false, "type": "string" }, "analytic_type": { "description": "Numeric type of this policy (17:Application Availability, 18:Link Congestion, 19:Link Outage, and 20:Application Performance)", "required": false, "type": "number" }, "analytic_name": { "description": "User frendly name for the 'analytic_type'. Can't be changed.", "required": false, "type": "string" }, "rule_id": { "description": "System defined ID for this policy.", "required": false, "type": "number" }, "aggregation_interval": { "description": "Data Aggregation Interval for this Policy in seconds.", "required": false, "type": "number" }, "enabled": { "description": "Boolean: This policy is enabled.", "required": false, "type": "boolean" }, "description": { "description": "Free form policy description. May be changed at any time.", "required": false, "type": "string" }, "metrics": { "description": "Policy Metrics", "required": true, "type": "array", "items": { "description": "Policy Metric", "type": "object", "id": "metric", "properties": { "name": { "description": "System name of this Metric. Can't be changed.", "required": false, "type": "string" }, "id": { "description": "System ID of this Metric. Can't be changed.", "required": false, "type": "number" }, "tolerance_high": { "description": "High Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "tolerance_low": { "description": "Low Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "noise_floor": { "description": "Analytic Noise noise_floor for this metric. This setting can be changed.", "required": false, "type": "number" }, "duration": { "description": "Required duration of anomoly required to trigger this metric. May not be edited.", "required": false, "type": "number" }, "trigger_on_increases": { "description": "Boolean: This policy will trigger on increase. May not be edited.", "required": false, "type": "boolean" }, "trigger_on_decreases": { "description": "Boolean: This policy will trigger on decrease. May not be edited.", "required": false, "type": "boolean" } } } }, "notifications": { "description": "Event Notifications", "required": true, "type": "array", "items": { "description": "Event Notification", "type": "object", "id": "event_notification", "properties": { "notification_type": { "description": "The 'type of this notification ('high', 'medium', or 'low).", "required": false, "type": "string" }, "enabled": { "description": "Boolean: Is this notification active.", "required": false, "type": "boolean" }, "recipient": { "description": "The system numeric ID for this recipient.", "required": false, "type": "number" }, "recipient_name": { "description": "The system name for this recipient.", "required": false, "type": "string" } } } }, "selexpr": { "description": "Policy Selector Expressions.", "required": true, "type": "array", "items": { "description": "Selector Expression", "type": "object", "id": "selector_expression", "properties": { "expr_type": { "description": "Expression type ('apps', 'ports', 'appports', 'hosts', 'servers', 'servers_excluded', 'clients', 'clients_excluded', 'client_location', 'interface', or 'dscp')", "required": false, "type": "string" }, "expr_value": { "description": "Expression Value", "required": false, "type": "string" } } } } }, "id": "perf_avail_policy", "type": "object" }, "id": "perf_avail_policies", "type": "array", "example": [ { "policy_type": 301989914, "event_name": "Link_Con_Test_01", "analytic_type": 18, "analytic_name": "Link Congestion", "rule_id": 26, "aggregation_interval": 900, "enabled": true, "description": "Link_Con_Test_01", "metrics": [ { "name": "bytes_in", "id": 7, "tolerance_high": 8, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 }, { "name": "bytes_out", "id": 8, "tolerance_high": 7, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 } ], "notifications": [ { "notification_type": "low", "enabled": true, "recipient": 1, "recipient_name": "Default" }, { "notification_type": "high", "enabled": true, "recipient": 1, "recipient_name": "Default" } ], "selexpr": [ { "expr_type": "apps", "expr_value": "" }, { "expr_type": "ports", "expr_value": "" }, { "expr_type": "appports", "expr_value": "" }, { "expr_type": "hosts", "expr_value": "" }, { "expr_type": "servers", "expr_value": "" }, { "expr_type": "servers_excluded", "expr_value": "" }, { "expr_type": "clients", "expr_value": "" }, { "expr_type": "clients_excluded", "expr_value": "" }, { "expr_type": "client_location", "expr_value": "" }, { "expr_type": "interface", "expr_value": "10.38.130.100:1000" }, { "expr_type": "dscp", "expr_value": "" } ] }, { "policy_type": 335544345, "event_name": "App_Perf_Test_01", "analytic_type": 20, "analytic_name": "Application Performance", "rule_id": 25, "aggregation_interval": 900, "enabled": true, "description": "App_Perf_Test_01", "metrics": [ { "name": "conns_new", "id": 2, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "conns_active", "id": 11, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "conns_duration", "id": 12, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "resp", "id": 4, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "rsts", "id": 5, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "retransbw", "id": 9, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "app_thruput_persecconn", "id": 13, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": false, "trigger_on_decreases": true } ], "notifications": [ { "notification_type": "low", "enabled": true, "recipient": 1, "recipient_name": "Default" }, { "notification_type": "high", "enabled": true, "recipient": 1, "recipient_name": "Default" } ], "selexpr": [ { "expr_type": "apps", "expr_value": "" }, { "expr_type": "ports", "expr_value": "TCP/22" }, { "expr_type": "appports", "expr_value": "" }, { "expr_type": "hosts", "expr_value": "" }, { "expr_type": "servers", "expr_value": "10.38/16" }, { "expr_type": "servers_excluded", "expr_value": "" }, { "expr_type": "clients", "expr_value": "" }, { "expr_type": "clients_excluded", "expr_value": "" }, { "expr_type": "client_location", "expr_value": "" }, { "expr_type": "interface", "expr_value": "" }, { "expr_type": "dscp", "expr_value": "" } ] } ], "authorization": "required" } }, "Configure Perf/Avail Policies": { "description": "Configure Performance and Availability Policies.", "formats": [ "json" ], "httpmethod": "POST", "path": "perf_availability", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "New/Updated Performance and Availability Policies.", "items": { "description": "New/Updated Performance and Availability Policy", "required": false, "properties": { "policy_type": { "description": "Type of this policy. Required to alter existing policy. Will be ignored for new policies.", "required": false, "type": "number" }, "event_name": { "description": "Name of this policy. Name given to the policy by the user when it is created. Can't be edited", "required": false, "type": "string" }, "analytic_type": { "description": "Numeric type of this policy (17:Application Availability, 18:Link Congestion, 19:Link Outage, and 20:Application Performance)", "required": false, "type": "number" }, "analytic_name": { "description": "User frendly name for the 'analytic_type'. Can't be edited.", "required": false, "type": "string" }, "rule_id": { "description": "System defined ID for this policy. Required to alter existing policy. Will be ignored for new policies.", "required": false, "type": "number" }, "aggregation_interval": { "description": "Data Aggregation Interval for this Policy in seconds. Can't be edited.", "required": false, "type": "number" }, "enabled": { "description": "Boolean: This policy is enabled.", "required": false, "type": "boolean" }, "description": { "description": "Free form policy description. May be changed at any time.", "required": false, "type": "string" }, "metrics": { "description": "Policy Metrics", "required": true, "type": "array", "items": { "description": "Policy Metric", "type": "object", "id": "metric", "properties": { "name": { "description": "System name of this Metric. Can't be changed.", "required": false, "type": "string" }, "id": { "description": "System ID of this Metric. Can't be changed.", "required": false, "type": "number" }, "tolerance_high": { "description": "High Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "tolerance_low": { "description": "Low Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "noise_floor": { "description": "Analytic Noise noise_floor for this metric. This setting can be changed.", "required": false, "type": "number" }, "duration": { "description": "Required duration of anomoly required to trigger this metric. May not be edited.", "required": false, "type": "number" }, "trigger_on_increases": { "description": "Boolean: This policy will trigger on increase. May not be edited.", "required": false, "type": "boolean" }, "trigger_on_decreases": { "description": "Boolean: This policy will trigger on decrease. May not be edited.", "required": false, "type": "boolean" } } } }, "notifications": { "description": "Event Notifications", "required": true, "type": "array", "items": { "description": "Event Notification", "type": "object", "id": "event_notification", "properties": { "notification_type": { "description": "The 'type of this notification ('high', 'medium', or 'low).", "required": false, "type": "string" }, "enabled": { "description": "Boolean: Is this notification active.", "required": false, "type": "boolean" }, "recipient": { "description": "The system numeric ID for this recipient.", "required": false, "type": "number" }, "recipient_name": { "description": "The system name for this recipient.", "required": false, "type": "string" } } } }, "selexpr": { "description": "Policy Selector Expressions. These settings can only be entered at policy creation. Can't be edited.", "required": true, "type": "array", "items": { "description": "Selector Expression", "type": "object", "id": "selector_expression", "properties": { "expr_type": { "description": "Expression type ('apps', 'ports', 'appports', 'hosts', 'servers', 'servers_excluded', 'clients', 'clients_excluded', 'client_location', 'interface', or 'dscp')", "required": false, "type": "string" }, "expr_value": { "description": "Expression Value", "required": false, "type": "string" } } } } }, "id": "new_update_perf_avail_policy", "type": "object" }, "id": "new_update_perf_avail_policies", "type": "array", "example": [ { "policy_type": 301989914, "event_name": "Link_Con_Test_01", "analytic_type": 18, "analytic_name": "Link Congestion", "rule_id": 26, "aggregation_interval": 900, "enabled": true, "description": "Link_Con_Test_01", "metrics": [ { "name": "bytes_in", "id": 7, "tolerance_high": 8, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 }, { "name": "bytes_out", "id": 8, "tolerance_high": 7, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 } ], "notifications": [ { "notification_type": "low", "enabled": true, "recipient": 1, "recipient_name": "Default" }, { "notification_type": "high", "enabled": true, "recipient": 1, "recipient_name": "Default" } ], "selexpr": [ { "expr_type": "apps", "expr_value": "" }, { "expr_type": "ports", "expr_value": "" }, { "expr_type": "appports", "expr_value": "" }, { "expr_type": "hosts", "expr_value": "" }, { "expr_type": "servers", "expr_value": "" }, { "expr_type": "servers_excluded", "expr_value": "" }, { "expr_type": "clients", "expr_value": "" }, { "expr_type": "clients_excluded", "expr_value": "" }, { "expr_type": "client_location", "expr_value": "" }, { "expr_type": "interface", "expr_value": "10.38.130.100:1000" }, { "expr_type": "dscp", "expr_value": "" } ] }, { "policy_type": 335544345, "event_name": "App_Perf_Test_01", "analytic_type": 20, "analytic_name": "Application Performance", "rule_id": 25, "aggregation_interval": 900, "enabled": true, "description": "App_Perf_Test_01", "metrics": [ { "name": "conns_new", "id": 2, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "conns_active", "id": 11, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "conns_duration", "id": 12, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "resp", "id": 4, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "rsts", "id": 5, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "retransbw", "id": 9, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false }, { "name": "app_thruput_persecconn", "id": 13, "tolerance_high": 8, "tolerance_low": 7, "noise_floor": 0, "duration": 1, "trigger_on_increases": false, "trigger_on_decreases": true } ], "notifications": [ { "notification_type": "low", "enabled": true, "recipient": 1, "recipient_name": "Default" }, { "notification_type": "high", "enabled": true, "recipient": 1, "recipient_name": "Default" } ], "selexpr": [ { "expr_type": "apps", "expr_value": "" }, { "expr_type": "ports", "expr_value": "TCP/22" }, { "expr_type": "appports", "expr_value": "" }, { "expr_type": "hosts", "expr_value": "" }, { "expr_type": "servers", "expr_value": "10.38/16" }, { "expr_type": "servers_excluded", "expr_value": "" }, { "expr_type": "clients", "expr_value": "" }, { "expr_type": "clients_excluded", "expr_value": "" }, { "expr_type": "client_location", "expr_value": "" }, { "expr_type": "interface", "expr_value": "" }, { "expr_type": "dscp", "expr_value": "" } ] } ], "authorization": "required" } }, "Display Perf/Avail Policy by Name": { "description": "Display a Performance and Availability Policy by Name.", "formats": [ "json" ], "httpmethod": "GET", "path": "perf_availability/{event_name}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Display Performance and Availability Policy by Name.", "properties": { "policy_type": { "description": "Type of this policy. Required to alter existing policy. Will be ignored for new policies.", "required": false, "type": "number" }, "event_name": { "description": "Name of this policy. Name given to the policy by the user when it is created. Can't be edited", "required": false, "type": "string" }, "analytic_type": { "description": "Numeric type of this policy (17:Application Availability, 18:Link Congestion, 19:Link Outage, and 20:Application Performance)", "required": false, "type": "number" }, "analytic_name": { "description": "User frendly name for the 'analytic_type'. Can't be edited.", "required": false, "type": "string" }, "rule_id": { "description": "System defined ID for this policy. Required to alter existing policy. Will be ignored for new policies.", "required": false, "type": "number" }, "aggregation_interval": { "description": "Data Aggregation Interval for this Policy in seconds. Can't be edited.", "required": false, "type": "number" }, "enabled": { "description": "Boolean: This policy is enabled.", "required": false, "type": "boolean" }, "description": { "description": "Free form policy description. May be changed at any time.", "required": false, "type": "string" }, "metrics": { "description": "Policy Metrics", "required": true, "type": "array", "items": { "description": "Policy Metric", "type": "object", "id": "metric", "properties": { "name": { "description": "System name of this Metric. Can't be changed.", "required": false, "type": "string" }, "id": { "description": "System ID of this Metric. Can't be changed.", "required": false, "type": "number" }, "tolerance_high": { "description": "High Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "tolerance_low": { "description": "Low Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "noise_floor": { "description": "Analytic Noise noise_floor for this metric. This setting can be changed.", "required": false, "type": "number" }, "duration": { "description": "Required duration of anomoly required to trigger this metric. May not be edited.", "required": false, "type": "number" }, "trigger_on_increases": { "description": "Boolean: This policy will trigger on increase. May not be edited.", "required": false, "type": "boolean" }, "trigger_on_decreases": { "description": "Boolean: This policy will trigger on decrease. May not be edited.", "required": false, "type": "boolean" } } } }, "notifications": { "description": "Event Notifications", "required": true, "type": "array", "items": { "description": "Event Notification", "type": "object", "id": "event_notification", "properties": { "notification_type": { "description": "The 'type of this notification ('high', 'medium', or 'low).", "required": false, "type": "string" }, "enabled": { "description": "Boolean: Is this notification active.", "required": false, "type": "boolean" }, "recipient": { "description": "The system numeric ID for this recipient.", "required": false, "type": "number" }, "recipient_name": { "description": "The system name for this recipient.", "required": false, "type": "string" } } } }, "selexpr": { "description": "Policy Selector Expressions. These settings can only be entered at policy creation. Can't be edited.", "required": true, "type": "array", "items": { "description": "Selector Expression", "type": "object", "id": "selector_expression", "properties": { "expr_type": { "description": "Expression type ('apps', 'ports', 'appports', 'hosts', 'servers', 'servers_excluded', 'clients', 'clients_excluded', 'client_location', 'interface', or 'dscp')", "required": false, "type": "string" }, "expr_value": { "description": "Expression Value", "required": false, "type": "string" } } } } }, "id": "single_perf_avail_policy", "type": "object", "example": { "policy_type": 301989914, "event_name": "Link_Con_Test_01", "analytic_type": 18, "analytic_name": "Link Congestion", "rule_id": 26, "aggregation_interval": 900, "enabled": true, "description": "Link_Con_Test_01", "metrics": [ { "name": "bytes_in", "id": 7, "tolerance_high": 8, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 }, { "name": "bytes_out", "id": 8, "tolerance_high": 7, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 } ], "notifications": [ { "notification_type": "low", "enabled": true, "recipient": 1, "recipient_name": "Default" }, { "notification_type": "high", "enabled": true, "recipient": 1, "recipient_name": "Default" } ], "selexpr": [ { "expr_type": "apps", "expr_value": "" }, { "expr_type": "ports", "expr_value": "" }, { "expr_type": "appports", "expr_value": "" }, { "expr_type": "hosts", "expr_value": "" }, { "expr_type": "servers", "expr_value": "" }, { "expr_type": "servers_excluded", "expr_value": "" }, { "expr_type": "clients", "expr_value": "" }, { "expr_type": "clients_excluded", "expr_value": "" }, { "expr_type": "client_location", "expr_value": "" }, { "expr_type": "interface", "expr_value": "10.38.130.100:1000" }, { "expr_type": "dscp", "expr_value": "" } ] }, "authorization": "required" } }, "Update Perf/Avail Policy by Name": { "description": "Update a Performance and Availability Policy by Name.", "formats": [ "json" ], "httpmethod": "POST", "path": "perf_availability/{event_name}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "Display Performance and Availability Policy by Name.", "properties": { "policy_type": { "description": "Type of this policy. Required to alter existing policy. Will be ignored for new policies.", "required": false, "type": "number" }, "event_name": { "description": "Name of this policy. Name given to the policy by the user when it is created. Can't be edited", "required": false, "type": "string" }, "analytic_type": { "description": "Numeric type of this policy (17:Application Availability, 18:Link Congestion, 19:Link Outage, and 20:Application Performance)", "required": false, "type": "number" }, "analytic_name": { "description": "User frendly name for the 'analytic_type'. Can't be edited.", "required": false, "type": "string" }, "rule_id": { "description": "System defined ID for this policy. Required to alter existing policy. Will be ignored for new policies.", "required": false, "type": "number" }, "aggregation_interval": { "description": "Data Aggregation Interval for this Policy in seconds. Can't be edited.", "required": false, "type": "number" }, "enabled": { "description": "Boolean: This policy is enabled.", "required": false, "type": "boolean" }, "description": { "description": "Free form policy description. May be changed at any time.", "required": false, "type": "string" }, "metrics": { "description": "Policy Metrics", "required": true, "type": "array", "items": { "description": "Policy Metric", "type": "object", "id": "metric", "properties": { "name": { "description": "System name of this Metric. Can't be changed.", "required": false, "type": "string" }, "id": { "description": "System ID of this Metric. Can't be changed.", "required": false, "type": "number" }, "tolerance_high": { "description": "High Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "tolerance_low": { "description": "Low Analytic Tolarance for this metric. This setting can be changed.", "required": false, "type": "number" }, "noise_floor": { "description": "Analytic Noise noise_floor for this metric. This setting can be changed.", "required": false, "type": "number" }, "duration": { "description": "Required duration of anomoly required to trigger this metric. May not be edited.", "required": false, "type": "number" }, "trigger_on_increases": { "description": "Boolean: This policy will trigger on increase. May not be edited.", "required": false, "type": "boolean" }, "trigger_on_decreases": { "description": "Boolean: This policy will trigger on decrease. May not be edited.", "required": false, "type": "boolean" } } } }, "notifications": { "description": "Event Notifications", "required": true, "type": "array", "items": { "description": "Event Notification", "type": "object", "id": "event_notification", "properties": { "notification_type": { "description": "The 'type of this notification ('high', 'medium', or 'low).", "required": false, "type": "string" }, "enabled": { "description": "Boolean: Is this notification active.", "required": false, "type": "boolean" }, "recipient": { "description": "The system numeric ID for this recipient.", "required": false, "type": "number" }, "recipient_name": { "description": "The system name for this recipient.", "required": false, "type": "string" } } } }, "selexpr": { "description": "Policy Selector Expressions. These settings can only be entered at policy creation. Can't be edited.", "required": true, "type": "array", "items": { "description": "Selector Expression", "type": "object", "id": "selector_expression", "properties": { "expr_type": { "description": "Expression type ('apps', 'ports', 'appports', 'hosts', 'servers', 'servers_excluded', 'clients', 'clients_excluded', 'client_location', 'interface', or 'dscp')", "required": false, "type": "string" }, "expr_value": { "description": "Expression Value", "required": false, "type": "string" } } } } }, "id": "single_perf_avail_policy", "type": "object", "example": { "policy_type": 301989914, "event_name": "Link_Con_Test_01", "analytic_type": 18, "analytic_name": "Link Congestion", "rule_id": 26, "aggregation_interval": 900, "enabled": true, "description": "Link_Con_Test_01", "metrics": [ { "name": "bytes_in", "id": 7, "tolerance_high": 8, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 }, { "name": "bytes_out", "id": 8, "tolerance_high": 7, "tolerance_low": 6, "noise_floor": 0, "duration": 1, "trigger_on_increases": true, "trigger_on_decreases": false, "thresh_high_enabled": false, "thresh_high": 95, "thresh_low_enabled": false, "thresh_low": 0 } ], "notifications": [ { "notification_type": "low", "enabled": true, "recipient": 1, "recipient_name": "Default" }, { "notification_type": "high", "enabled": true, "recipient": 1, "recipient_name": "Default" } ], "selexpr": [ { "expr_type": "apps", "expr_value": "" }, { "expr_type": "ports", "expr_value": "" }, { "expr_type": "appports", "expr_value": "" }, { "expr_type": "hosts", "expr_value": "" }, { "expr_type": "servers", "expr_value": "" }, { "expr_type": "servers_excluded", "expr_value": "" }, { "expr_type": "clients", "expr_value": "" }, { "expr_type": "clients_excluded", "expr_value": "" }, { "expr_type": "client_location", "expr_value": "" }, { "expr_type": "interface", "expr_value": "10.38.130.100:1000" }, { "expr_type": "dscp", "expr_value": "" } ] }, "authorization": "required" } } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with NetProfiler products. 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\npolicies can be accessed and how to configure them.\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" }