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.
This endpoint requires the network_health_insights_read permission.
Arguments
Query Strings
Name
Type
Description
from
string
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].
to
string
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 containing a list of network health insights for the organization.
Expand All
Field
Type
Description
data [required]
[object]
Array of network health insights returned for the query window.
attributes [required]
object
Detailed attributes of a network health insight.
account_id
string
AWS account identifier where the certificate is located. Only set for tls-cert insights.
certificate_id
string
ARN or identifier of the certificate. Only set for tls-cert insights.
certificate_lifetime_percent
double
Percentage of the certificate's validity period that has elapsed, ranging from 0 to 100.
Only set for tls-cert insights.
client_region
string
AWS region where the client is located. Only set for tls-cert insights.
client_service
string
Name of the service making the request (DNS query or TLS-secured connection).
Set to N/A when the client service cannot be determined.
days_until_expiration
int64
Number of days remaining until the certificate expires. Negative values indicate the
certificate has already expired. Only set for tls-cert insights.
dns_query
string
Domain name that was being resolved when the DNS failure occurred. Only set for dns insights.
dns_server
string
DNS server that received the failing query. Only set for dns insights.
domain_name
string
Domain name covered by the certificate. Only set for tls-cert insights.
failure_magnitude
int64
Count of failed events observed during the query window. Only set for dns, tcp,
and security-group insights.
failure_rate
double
Percentage of requests that failed during the query window, ranging from 0 to 100.
Only set for dns, tcp, and security-group insights.
failure_type
enum
Specific failure type within the insight category. For DNS insights: timeout, nxdomain,
servfail, or general_failure. For TLS certificate insights: expired or expiring_soon.
For security group insights: denied.
Allowed enum values: timeout,nxdomain,servfail,general_failure,expired,expiring_soon,denied
loadbalancer_id
string
ARN of the load balancer using the certificate. Only set for tls-cert insights.
server_region
string
AWS region where the server or load balancer is located. Only set for tls-cert insights.
server_service
string
Name of the target service the client was trying to reach.
total_requests
int64
Total number of requests observed during the query window. Provides context for
failure_magnitude and failure_rate. Only set for dns, tcp, and security-group insights.
traffic_volume
object
Network traffic volume metrics between the client and server services during the query window.
bytes_read
int64
Total bytes read from the server to the client during the query window.
bytes_written
int64
Total bytes written from the client to the server during the query window.
total_traffic
int64
Sum of bytes written and bytes read across the query window.
type
enum
Category of network health insight. Indicates whether the insight relates to a DNS issue (dns),
a TCP issue (tcp), a TLS certificate issue (tls-cert), or a security group denial (security-group).
Allowed enum values: dns,tcp,tls-cert,security-group
id [required]
string
Unique identifier for this network health insight.
type [required]
enum
The resource type for network health insights. Always network-health-insights.
Allowed enum values: network-health-insights
"""
List network health insights returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.network_health_insights_apiimportNetworkHealthInsightsApiconfiguration=Configuration()configuration.unstable_operations["list_network_health_insights"]=TruewithApiClient(configuration)asapi_client:api_instance=NetworkHealthInsightsApi(api_client)response=api_instance.list_network_health_insights()print(response)
# List network health insights returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.list_network_health_insights".to_sym]=trueendapi_instance=DatadogAPIClient::V2::NetworkHealthInsightsAPI.newpapi_instance.list_network_health_insights()
// List network health insights returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.ListNetworkHealthInsights",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewNetworkHealthInsightsApi(apiClient)resp,r,err:=api.ListNetworkHealthInsights(ctx,*datadogV2.NewListNetworkHealthInsightsOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `NetworkHealthInsightsApi.ListNetworkHealthInsights`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `NetworkHealthInsightsApi.ListNetworkHealthInsights`:\n%s\n",responseContent)}
// List network health insights returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_network_health_insights::ListNetworkHealthInsightsOptionalParams;usedatadog_api_client::datadogV2::api_network_health_insights::NetworkHealthInsightsAPI;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.ListNetworkHealthInsights",true);letapi=NetworkHealthInsightsAPI::with_config(configuration);letresp=api.list_network_health_insights(ListNetworkHealthInsightsOptionalParams::default()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* List network health insights returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.listNetworkHealthInsights"]=true;constapiInstance=newv2.NetworkHealthInsightsApi(configuration);apiInstance.listNetworkHealthInsights().then((data: v2.NetworkHealthInsightsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));