Get Enterprise Firewall Edge Summary Metrics

Fetch Edge Summary for an Enterprise.The actions taken for various secure engine types, e.g. IDPS, URL Filtering, and Malicious IP.

Request

URI

GET

https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/firewallEdgeSummaryMetrics

COPY

Path Parameters

string

enterpriseLogicalId

Required

The logicalId GUID for the target enterprise

Query Parameters

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 enterpriseFirewallEdgeSummary

Possible values are : idpsActions, urlCatActions, urlRepActions, malIpActions,

Responses

200

Request successfully processed

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

[
    {
        "name": "string",
        "edgeLogicalId": "string",
        "edgeId": "number",
        "idpsActions": {
            "threatsCount": "number",
            "detectedThreatsCount": "number",
            "preventedThreatsCount": "number"
        },
        "urlCatActions": {
            "threatsCount": "number",
            "urlsAllowedCount": "number",
            "urlsBlockedCount": "number",
            "urlsMonitoredCount": "number"
        },
        "urlRepActions": {
            "threatsCount": "number",
            "urlsAllowedCount": "number",
            "urlsBlockedCount": "number",
            "urlsMonitoredCount": "number"
        },
        "malIpActions": {
            "threatsCount": "number",
            "urlsAllowedCount": "number",
            "urlsBlockedCount": "number"
        },
        "totalActions": {
            "threatsCount": "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}/firewallEdgeSummaryMetrics?start=value&metrics=v

On This Page

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Errors

Monitor Operations

GET

Get Enterprises

POST