Get Edge Firewall Idps Stats Series

Fetch Enhanced Firewall idps stats. Data of detected threats are returned as a time series in 5 minute intervals. Prior to version 6.0 use firewallStatsSeries

Request

URI

GET

https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/firewallIdpsStats/timeSeries

COPY

Path Parameters

string

enterpriseLogicalId

Required

The logicalId GUID for the target enterprise

string

edgeLogicalId

Required

The logicalId GUID for the target edge

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

Required

Metrics supported for querying firewallIdpsStatsSeries

Possible values are : threatsCount, highThreatsCount, mediumThreatsCount, lowThreatsCount, criticalThreatsCount, suspiciousThreatsCount,

integer

maxSamples

Optional

Constraints: default: 512

An integer value specifying the max samples for firewall stats

Responses

200

Request successfully processed

Returns Array of object of type(s) application/json

[
    {
        "name": "string",
        "series": [
            {
                "metric": "string",
                "startTime": "string",
                "tickInterval": "number",
                "data": [
                    {}
                ],
                "total": "number",
                "min": "number",
                "max": "number"
            }
        ]
    }
]

400

ValidationError

Returns ValidationError of type(s) application/json

"ValidationError Object"

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 object

errors

Optional

A list of property-specific errors

401

Unauthorized

Returns UnAuthorized of type(s) application/json

"UnAuthorized Object"

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

"ResourceNotFoundError Object"

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

"RateLimitExceededError Object"

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

"InternalServerError Object"

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

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/firewallIdpsStats/timeSeries?start=value&metrics=v

On This Page

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Errors

Monitor Operations

GET

Get Enterprise Edges

POST