Get Enterprise Firewall Malicious Ip Metrics

Get Enterprise Firewall Malicious Ip Metrics

Fetch Enhanced Firewall Malicious IP stats. Metrics include Top Malicious IPs, Top Blocked Clients, etc. The groupBy parameter controls which metric is returned.

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/firewallMaliciousIpMetrics
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

Query Parameters
string
include
Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.

integer
start
Required

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.

integer
end
Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.

string
metrics
Optional

Metrics possible to return when querying firewall malicious ip metrics

Possible values are : threatsCount, monitoredThreatsCount, blockedThreatsCount,
string
groupBy
Required

Determines the type of query made when querying firewall malicious ip metrics

Possible values are : action, destIp, ipCategory, sourceIp, undefined, edgeLogicalId,
string
with
Optional

Additional column to return when querying Enterprise-level Malicious IP stats

string
sortBy
Optional

Sort Malicious IP results by a metric, defaults to threatsCount

Possible values are : threatsCount, monitoredThreatsCount, blockedThreatsCount,
Responses
200

Request successfully processed

Returns Array of EnterpriseFirewallMalIpResource of type(s) application/json 
[
    {
        "name": "string",
        "threatsCount": "number",
        "blockedThreatsCount": "number",
        "monitoredThreatsCount": "number",
        "edgeLogicalId": "string"
    }
]

400

ValidationError

Returns ValidationError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "string"
        }
    ]
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation

array of ValidationErrorListItem
errors
Optional

A list of property-specific errors


401

Unauthorized

Returns UnAuthorized of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


On This Page
Customers Operations
GET
Get Edge Firewall Idps Stats
GET
Get Edge Firewall Malicious Ip Metrics
GET
Get Edge Firewall Url Filtering Category Metrics
GET
Get Edge Firewall Url Filtering Reputation Metrics
GET
Get Enterprise Firewall Edge Count Metrics
GET
Get Enterprise Firewall Idps Stats
GET
Get Enterprise Firewall Malicious Ip Metrics
GET
Get Enterprise Firewall Url Filtering Category Metrics
GET
Get Enterprise Firewall Url Filtering Reputation Mtrics