v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Network Health Insights

List network health insights

Return network health insights for the organization within the given time window. Insights are produced by analyzing DNS failures pre-classified by network-dns-logger, TLS certificate metrics, and denied security group connections. Each insight identifies the client and server services involved, the type of issue, and the magnitude of the failure observed during the query window.

get/api/v2/network-health-insights

Query parameters

fromstring

Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the to timestamp. If neither from nor to are provided, the query window will be [now - 15m, now].

tostring

Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be the current time. If neither from nor to are provided, the query window will be [now - 15m, now].

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "account_id": "123456789012",
        "certificate_id": "arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-a123-456b-a123-12345678901f",
        "certificate_lifetime_percent": 96.7,
        "client_region": "us-west-2",
        "client_service": "network-logger",
        "days_until_expiration": 3,
        "dns_query": "kafka-broker.internal.domain.com",
        "dns_server": "cluster-dns",
        "domain_name": "api.example.com",
        "failure_magnitude": 150,
        "failure_rate": 91,
        "failure_type": "nxdomain",
        "loadbalancer_id": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188",
        "server_region": "us-east-1",
        "server_service": "kafka",
        "total_requests": 1200,
        "traffic_volume": {
          "bytes_read": 1800000,
          "bytes_written": 2500000,
          "total_traffic": 4300000
        },
        "type": "dns"
      },
      "id": "example-insight-id",
      "type": "network-health-insights"
    }
  ]
}