Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform DNS Firewall Analytics API

The DNS Firewall Analytics API from APIs.io Engineering Platform — 2 operation(s) for dns firewall analytics.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

2 operations 2 paths 18 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform DNS Firewall Analytics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

DNS Firewall Analytics 2
GET
/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report
APIs.io Engineering Platform Table
dns-firewall-analytics-table 9 params → 4XX200
GET
/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime
APIs.io Engineering Platform By Time
dns-firewall-analytics-by-time 10 params → 4XX200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are dns-analytics_query (7 properties), dns-analytics_result (7 properties), dns-analytics_api-response-common-failure (4 properties), dns-analytics_api-response-common (3 properties). Each schema is shown below with its type and property counts.

dns-analytics_filters
string
Segmentation filter in 'attribute operator value' format.
dns-analytics_report_bytime
dns-analytics_since
string
Start date and time of requesting data period in ISO 8601 format.
dns-analytics_limit
integer
Limit number of returned metrics.
dns-analytics_data
array
Array with one row per combination of dimension values.
dns-analytics_api-response-common
object
3 properties 3 required
dns-analytics_sort
string
A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
dns-analytics_metrics
string
A comma-separated list of metrics to query.
dns-analytics_report
dns-analytics_dimensions
string
A comma-separated list of dimensions to group results by.
dns-analytics_api-response-common-failure
object
4 properties 4 required
dns-analytics_identifier
string
Identifier
dns-analytics_until
string
End date and time of requesting data period in ISO 8601 format.
dns-analytics_query
object
7 properties 5 required
dns-analytics_api-response-single
object
dns-analytics_time_delta
string
Unit of time to group data by.
dns-analytics_result
object
7 properties 7 required
dns-analytics_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-dns-firewall-analytics-api-openapi.yml Raw ↑