WAwatchguard
Firebox Reports

Get data from the Firebox Security Dashboard report.

Retrieves the specified Security Dashboard records for the specified devices.

get/v1/report/{accountId}/security

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud Account ID.

Query parameters

view'top_blocked_countries' | 'top_blocked_advanced_malware_apt' | 'top_blocked_botnet_sites' | 'top_blocked_clients' | 'top_blocked_mobile_devices' | 'top_blocked_destinations' | 'top_blocked_url_categories' | 'top_blocked_applications' | 'top_blocked_application_categories' | 'top_blocked_protocols' | 'top_blocked_attacks' | 'top_blocked_malware' required

Specifies the type of Security Dashboard records to retrieve.

startDatestring required

Start date and time of the period to retrieve records for.

endDatestring required

End date and time of the period to retrieve records for.

devicesstring

Comma-separated device IDs of the Fireboxes and FireClusters to retrieve records for. If you do not specify device IDs, the API returns records for all Fireboxes and FireClusters in the account.

rowCountinteger

Number of records to return. The default value is 10 and the maximum value is 500.

filter'top_blocked_countries' | 'top_blocked_advanced_malware_apt' | 'top_blocked_botnet_sites' | 'top_blocked_clients' | 'top_blocked_mobile_devices' | 'top_blocked_destinations' | 'top_blocked_url_categories' | 'top_blocked_applications' | 'top_blocked_application_categories' | 'top_blocked_protocols' | 'top_blocked_attacks' | 'top_blocked_malware'

Type of Security Dashboard record to filter results on. Specify the filter in this parameter, then specify a filter value in the 'filterValue' parameter. For example, if the 'filter' parameter value is 'top_blocked_countries', then the 'filterValue' value could be 'USA'.

filterValuestring

Filter value to filter results by. Specify the filter in the 'filter' parameter, then specify a filter value in this parameter. For example, if the 'filter' parameter value is 'top_blocked_countries', then the 'filterValue' value could be 'USA'.

Response

List of Security Dashboard records that match the request.

statusstring
viewstring

Changes

No recorded changes to this operation across all 1 revision of this API.