Metrics Get Enterprise Firewall Idps Metrics

Metrics Get Enterprise Firewall Idps Metrics

Gets Firewall IDPS summaries for the enterprise over the specified time interval by the specified dimension, e.g. signatureName, threatImpact, alert, threatSourceIp, threatSourceGeoCountry, threatTargetIp and edgeLogicalId. On success, this method returns an array of aggregate data in which each entry corresponds to a single dimension.

Privileges required:

READ EDGE

VIEW_FIREWALL_LOGS undefined

Request
URI
POST
https://{api_host}/portal/rest/metrics/getEnterpriseFirewallIdpsMetrics
COPY
Request Body

Show optional properties

{
    "interval": {
        "start": "string"
    },
    "viewBy": "string"
}
{
    "enterpriseId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "viewBy": "string",
    "metrics": "enterprise_firewall_idps_basic_metrics Object",
    "sort": "enterprise_firewall_idps_basic_metric Object",
    "limit": 0,
    "other": false,
    "with": [
        "string"
    ],
    "filters": "metric_filters Object",
    "edgeLogicalIds": [
        "string"
    ]
}
integer
enterpriseId
Optional

enterpriseId

interval
interval
Required

interval

string
viewBy
Required

viewBy

Possible values are : signatureName, threatImpact, alert, threatSourceIp, threatTargetIp, threatSourceGeoCountry, edgeLogicalId,
enterprise_firewall_idps_basic_metrics
metrics
Optional

A list of metrics to report.

enterprise_firewall_idps_basic_metric
sort
Optional

sort

Possible values are : threatsCount, highThreatsCount, mediumThreatsCount, lowThreatsCount, criticalThreatsCount, suspiciousThreatsCount, edgesCount,
integer
limit
Optional

limit

boolean
other
Optional

Includes the metrics of the rest apart from the limited result

array of string
with
Optional

with

Possible values are : signatureId, threatImpact, signatureCategory, edgeLogicalId,
metric_filters
filters
Optional

filters

array of string
edgeLogicalIds
Optional

edgeLogicalIds

Responses
200

Request was successfully processed

Returns Array of object of type(s) application/json 
[
    {
        "name": "Unusual FTP Clear Text Password",
        "threatsCount": 11,
        "signatureId": 1048697,
        "threatImpact": "High",
        "signatureCategory": "command-and-control"
    },
    {
        "name": "Unusual Beckoning Activity",
        "threatsCount": 5,
        "signatureId": 2100498,
        "threatImpact": "MEDIUM",
        "signatureCategory": "trojan-activity"
    },
    {
        "name": "other",
        "metrics": {
            "threatsCount": 20
        }
    }
]

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"viewBy:"string","interval:"object"}' https://{api_host}/portal/rest/metrics/getEnterpriseFirewallIdpsMetrics
On This Page
Metrics Operations
POST
Metrics Get Edge Firewall Idps Metrics
POST
Metrics Get Edge Firewall Idps Series
POST
Metrics Get Edge Firewall Malicious Ip Metrics
POST
Metrics Get Edge Firewall Url Category Metrics
POST
Metrics Get Edge Firewall Url Reputation Metrics
POST
Metrics Get Enterprise Firewall Edge Summary Metrics
POST
Metrics Get Enterprise Firewall Idps Metrics
POST
Metrics Get Enterprise Firewall Malicious Ip Metrics
POST
Metrics Get Enterprise Firewall Url Category Metrics
POST
Metrics Get Enterprise Firewall Url Reputation Metrics