@@ -58756,6 +58756,191 @@ components:
5875658756 - type
5875758757 - attributes
5875858758 type: object
58759+ NetworkHealthInsight:
58760+ description: A single network health insight describing a service-to-service connectivity issue.
58761+ properties:
58762+ attributes:
58763+ $ref: "#/components/schemas/NetworkHealthInsightAttributes"
58764+ id:
58765+ description: Unique identifier for this network health insight.
58766+ example: example-insight-id
58767+ type: string
58768+ type:
58769+ $ref: "#/components/schemas/NetworkHealthInsightsType"
58770+ required:
58771+ - type
58772+ - id
58773+ - attributes
58774+ type: object
58775+ NetworkHealthInsightAttributes:
58776+ description: Detailed attributes of a network health insight.
58777+ properties:
58778+ account_id:
58779+ description: AWS account identifier where the certificate is located. Only set for `tls-cert` insights.
58780+ example: "123456789012"
58781+ type: string
58782+ certificate_id:
58783+ description: ARN or identifier of the certificate. Only set for `tls-cert` insights.
58784+ example: "arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-a123-456b-a123-12345678901f"
58785+ type: string
58786+ certificate_lifetime_percent:
58787+ description: |-
58788+ Percentage of the certificate's validity period that has elapsed, ranging from 0 to 100.
58789+ Only set for `tls-cert` insights.
58790+ example: 96.7
58791+ format: double
58792+ type: number
58793+ client_region:
58794+ description: AWS region where the client is located. Only set for `tls-cert` insights.
58795+ example: us-west-2
58796+ type: string
58797+ client_service:
58798+ description: |-
58799+ Name of the service making the request (DNS query or TLS-secured connection).
58800+ Set to `N/A` when the client service cannot be determined.
58801+ example: network-logger
58802+ type: string
58803+ days_until_expiration:
58804+ description: |-
58805+ Number of days remaining until the certificate expires. Negative values indicate the
58806+ certificate has already expired. Only set for `tls-cert` insights.
58807+ example: 3
58808+ format: int64
58809+ type: integer
58810+ dns_query:
58811+ description: Domain name that was being resolved when the DNS failure occurred. Only set for `dns` insights.
58812+ example: kafka-broker.internal.domain.com
58813+ type: string
58814+ dns_server:
58815+ description: DNS server that received the failing query. Only set for `dns` insights.
58816+ example: cluster-dns
58817+ type: string
58818+ domain_name:
58819+ description: Domain name covered by the certificate. Only set for `tls-cert` insights.
58820+ example: api.example.com
58821+ type: string
58822+ failure_magnitude:
58823+ description: |-
58824+ Count of failed events observed during the query window. Only set for `dns`, `tcp`,
58825+ and `security-group` insights.
58826+ example: 150
58827+ format: int64
58828+ minimum: 0
58829+ type: integer
58830+ failure_rate:
58831+ description: |-
58832+ Percentage of requests that failed during the query window, ranging from 0 to 100.
58833+ Only set for `dns`, `tcp`, and `security-group` insights.
58834+ example: 91
58835+ format: double
58836+ maximum: 100
58837+ minimum: 0
58838+ type: number
58839+ failure_type:
58840+ $ref: "#/components/schemas/NetworkHealthInsightFailureType"
58841+ loadbalancer_id:
58842+ description: ARN of the load balancer using the certificate. Only set for `tls-cert` insights.
58843+ example: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188"
58844+ type: string
58845+ server_region:
58846+ description: AWS region where the server or load balancer is located. Only set for `tls-cert` insights.
58847+ example: us-east-1
58848+ type: string
58849+ server_service:
58850+ description: Name of the target service the client was trying to reach.
58851+ example: kafka
58852+ type: string
58853+ total_requests:
58854+ description: |-
58855+ Total number of requests observed during the query window. Provides context for
58856+ `failure_magnitude` and `failure_rate`. Only set for `dns`, `tcp`, and `security-group` insights.
58857+ example: 1200
58858+ format: int64
58859+ minimum: 0
58860+ type: integer
58861+ traffic_volume:
58862+ $ref: "#/components/schemas/NetworkHealthInsightTrafficVolume"
58863+ type:
58864+ $ref: "#/components/schemas/NetworkHealthInsightCategory"
58865+ type: object
58866+ NetworkHealthInsightCategory:
58867+ description: |-
58868+ Category of network health insight. Indicates whether the insight relates to a DNS issue (`dns`),
58869+ a TCP issue (`tcp`), a TLS certificate issue (`tls-cert`), or a security group denial (`security-group`).
58870+ enum:
58871+ - dns
58872+ - tcp
58873+ - tls-cert
58874+ - security-group
58875+ example: dns
58876+ type: string
58877+ x-enum-varnames:
58878+ - DNS
58879+ - TCP
58880+ - TLS_CERT
58881+ - SECURITY_GROUP
58882+ NetworkHealthInsightFailureType:
58883+ description: |-
58884+ Specific failure type within the insight category. For DNS insights: `timeout`, `nxdomain`,
58885+ `servfail`, or `general_failure`. For TLS certificate insights: `expired` or `expiring_soon`.
58886+ For security group insights: `denied`.
58887+ enum:
58888+ - timeout
58889+ - nxdomain
58890+ - servfail
58891+ - general_failure
58892+ - expired
58893+ - expiring_soon
58894+ - denied
58895+ example: nxdomain
58896+ type: string
58897+ x-enum-varnames:
58898+ - TIMEOUT
58899+ - NXDOMAIN
58900+ - SERVFAIL
58901+ - GENERAL_FAILURE
58902+ - EXPIRED
58903+ - EXPIRING_SOON
58904+ - DENIED
58905+ NetworkHealthInsightTrafficVolume:
58906+ description: Network traffic volume metrics between the client and server services during the query window.
58907+ properties:
58908+ bytes_read:
58909+ description: Total bytes read from the server to the client during the query window.
58910+ example: 1800000
58911+ format: int64
58912+ type: integer
58913+ bytes_written:
58914+ description: Total bytes written from the client to the server during the query window.
58915+ example: 2500000
58916+ format: int64
58917+ type: integer
58918+ total_traffic:
58919+ description: Sum of bytes written and bytes read across the query window.
58920+ example: 4300000
58921+ format: int64
58922+ type: integer
58923+ type: object
58924+ NetworkHealthInsightsResponse:
58925+ description: Response containing a list of network health insights for the organization.
58926+ properties:
58927+ data:
58928+ description: Array of network health insights returned for the query window.
58929+ items:
58930+ $ref: "#/components/schemas/NetworkHealthInsight"
58931+ type: array
58932+ required:
58933+ - data
58934+ type: object
58935+ NetworkHealthInsightsType:
58936+ default: network-health-insights
58937+ description: The resource type for network health insights. Always `network-health-insights`.
58938+ enum:
58939+ - network-health-insights
58940+ example: network-health-insights
58941+ type: string
58942+ x-enum-varnames:
58943+ - NETWORK_HEALTH_INSIGHTS
5875958944 NodeType:
5876058945 additionalProperties: {}
5876158946 description: A tree-sitter node type definition for a given language, describing the node's structure, subtypes, and fields.
@@ -147568,6 +147753,118 @@ paths:
147568147753 summary: Update the tags for an interface
147569147754 tags:
147570147755 - Network Device Monitoring
147756+ /api/v2/network-health-insights:
147757+ get:
147758+ description: |-
147759+ Return network health insights for the organization within the given time window.
147760+ Insights are produced by analyzing DNS failures pre-classified by `network-dns-logger`,
147761+ TLS certificate metrics, and denied security group connections. Each insight
147762+ identifies the client and server services involved, the type of issue, and the
147763+ magnitude of the failure observed during the query window.
147764+ operationId: ListNetworkHealthInsights
147765+ parameters:
147766+ - description: |-
147767+ Unix timestamp (number of seconds since epoch) of the start of the query window.
147768+ If not provided, the start of the query window will be 15 minutes before the `to` timestamp.
147769+ If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
147770+ example: "1716800000"
147771+ in: query
147772+ name: from
147773+ required: false
147774+ schema:
147775+ type: string
147776+ - description: |-
147777+ Unix timestamp (number of seconds since epoch) of the end of the query window.
147778+ If not provided, the end of the query window will be the current time.
147779+ If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
147780+ example: "1716800900"
147781+ in: query
147782+ name: to
147783+ required: false
147784+ schema:
147785+ type: string
147786+ responses:
147787+ "200":
147788+ content:
147789+ application/json:
147790+ examples:
147791+ default:
147792+ value:
147793+ data:
147794+ - attributes:
147795+ client_service: "network-logger"
147796+ dns_query: "kafka-broker.internal.domain.com"
147797+ dns_server: "cluster-dns"
147798+ failure_magnitude: 150
147799+ failure_rate: 91
147800+ failure_type: "nxdomain"
147801+ server_service: "kafka"
147802+ total_requests: 1200
147803+ traffic_volume:
147804+ bytes_read: 1800000
147805+ bytes_written: 2500000
147806+ total_traffic: 4300000
147807+ type: "dns"
147808+ id: "example-insight-id"
147809+ type: "network-health-insights"
147810+ - attributes:
147811+ account_id: "123456789012"
147812+ certificate_id: "arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-a123-456b-a123-12345678901f"
147813+ certificate_lifetime_percent: 96.7
147814+ client_region: "us-west-2"
147815+ client_service: "N/A"
147816+ days_until_expiration: 3
147817+ domain_name: "api.example.com"
147818+ failure_type: "expiring_soon"
147819+ loadbalancer_id: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188"
147820+ server_region: "us-east-1"
147821+ server_service: "web-frontend"
147822+ type: "tls-cert"
147823+ id: "example-cert-insight-id"
147824+ type: "network-health-insights"
147825+ - attributes:
147826+ client_service: "web-frontend"
147827+ failure_magnitude: 85
147828+ failure_rate: 68.5
147829+ failure_type: "denied"
147830+ server_service: "database"
147831+ total_requests: 124
147832+ type: "security-group"
147833+ id: "example-security-group-insight-id"
147834+ type: "network-health-insights"
147835+ schema:
147836+ $ref: "#/components/schemas/NetworkHealthInsightsResponse"
147837+ description: OK
147838+ "400":
147839+ content:
147840+ application/json:
147841+ schema:
147842+ $ref: "#/components/schemas/JSONAPIErrorResponse"
147843+ description: Bad Request
147844+ "403":
147845+ content:
147846+ application/json:
147847+ schema:
147848+ $ref: "#/components/schemas/JSONAPIErrorResponse"
147849+ description: Forbidden
147850+ "429":
147851+ $ref: "#/components/responses/TooManyRequestsResponse"
147852+ "500":
147853+ content:
147854+ application/json:
147855+ schema:
147856+ $ref: "#/components/schemas/JSONAPIErrorResponse"
147857+ description: Internal Server Error
147858+ summary: List network health insights
147859+ tags:
147860+ - Network Health Insights
147861+ x-permission:
147862+ operator: OR
147863+ permissions:
147864+ - network_health_insights_read
147865+ x-unstable: |-
147866+ **Note**: This endpoint is in preview and is subject to change.
147867+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147571147868 /api/v2/network/connections/aggregate:
147572147869 get:
147573147870 description: Get all aggregated connections.
@@ -184667,6 +184964,11 @@ tags:
184667184964 - description: |-
184668184965 The Network Device Monitoring API allows you to fetch devices and interfaces and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/) for more information.
184669184966 name: Network Device Monitoring
184967+ - description: |-
184968+ Analyze network health by surfacing actionable insights for services experiencing connectivity issues.
184969+ Insights are derived from DNS failure data (timeouts, NXDOMAIN, SERVFAIL, general failures),
184970+ TLS certificate health (expired, expiring soon), and security group denials.
184971+ name: Network Health Insights
184670184972 - description: |-
184671184973 Configure OAuth2 clients for Datadog.
184672184974 Supports RFC 7591 Dynamic Client Registration and management of OAuth2 client scopes restrictions.
0 commit comments