@@ -56819,6 +56819,191 @@ components:
5681956819 - type
5682056820 - id
5682156821 type: object
56822+ NetworkHealthInsight:
56823+ description: A single network health insight describing a service-to-service connectivity issue.
56824+ properties:
56825+ attributes:
56826+ $ref: "#/components/schemas/NetworkHealthInsightAttributes"
56827+ id:
56828+ description: Unique identifier for this network health insight.
56829+ example: example-insight-id
56830+ type: string
56831+ type:
56832+ $ref: "#/components/schemas/NetworkHealthInsightsType"
56833+ required:
56834+ - type
56835+ - id
56836+ - attributes
56837+ type: object
56838+ NetworkHealthInsightAttributes:
56839+ description: Detailed attributes of a network health insight.
56840+ properties:
56841+ account_id:
56842+ description: AWS account identifier where the certificate is located. Only set for `tls-cert` insights.
56843+ example: "123456789012"
56844+ type: string
56845+ certificate_id:
56846+ description: ARN or identifier of the certificate. Only set for `tls-cert` insights.
56847+ example: "arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-a123-456b-a123-12345678901f"
56848+ type: string
56849+ certificate_lifetime_percent:
56850+ description: |-
56851+ Percentage of the certificate's validity period that has elapsed, ranging from 0 to 100.
56852+ Only set for `tls-cert` insights.
56853+ example: 96.7
56854+ format: double
56855+ type: number
56856+ client_region:
56857+ description: AWS region where the client is located. Only set for `tls-cert` insights.
56858+ example: us-west-2
56859+ type: string
56860+ client_service:
56861+ description: |-
56862+ Name of the service making the request (DNS query or TLS-secured connection).
56863+ Set to `N/A` when the client service cannot be determined.
56864+ example: network-logger
56865+ type: string
56866+ days_until_expiration:
56867+ description: |-
56868+ Number of days remaining until the certificate expires. Negative values indicate the
56869+ certificate has already expired. Only set for `tls-cert` insights.
56870+ example: 3
56871+ format: int64
56872+ type: integer
56873+ dns_query:
56874+ description: Domain name that was being resolved when the DNS failure occurred. Only set for `dns` insights.
56875+ example: kafka-broker.internal.domain.com
56876+ type: string
56877+ dns_server:
56878+ description: DNS server that received the failing query. Only set for `dns` insights.
56879+ example: cluster-dns
56880+ type: string
56881+ domain_name:
56882+ description: Domain name covered by the certificate. Only set for `tls-cert` insights.
56883+ example: api.example.com
56884+ type: string
56885+ failure_magnitude:
56886+ description: |-
56887+ Count of failed events observed during the query window. Only set for `dns`, `tcp`,
56888+ and `security-group` insights.
56889+ example: 150
56890+ format: int64
56891+ minimum: 0
56892+ type: integer
56893+ failure_rate:
56894+ description: |-
56895+ Percentage of requests that failed during the query window, ranging from 0 to 100.
56896+ Only set for `dns`, `tcp`, and `security-group` insights.
56897+ example: 91
56898+ format: double
56899+ maximum: 100
56900+ minimum: 0
56901+ type: number
56902+ failure_type:
56903+ $ref: "#/components/schemas/NetworkHealthInsightFailureType"
56904+ loadbalancer_id:
56905+ description: ARN of the load balancer using the certificate. Only set for `tls-cert` insights.
56906+ example: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188"
56907+ type: string
56908+ server_region:
56909+ description: AWS region where the server or load balancer is located. Only set for `tls-cert` insights.
56910+ example: us-east-1
56911+ type: string
56912+ server_service:
56913+ description: Name of the target service the client was trying to reach.
56914+ example: kafka
56915+ type: string
56916+ total_requests:
56917+ description: |-
56918+ Total number of requests observed during the query window. Provides context for
56919+ `failure_magnitude` and `failure_rate`. Only set for `dns`, `tcp`, and `security-group` insights.
56920+ example: 1200
56921+ format: int64
56922+ minimum: 0
56923+ type: integer
56924+ traffic_volume:
56925+ $ref: "#/components/schemas/NetworkHealthInsightTrafficVolume"
56926+ type:
56927+ $ref: "#/components/schemas/NetworkHealthInsightCategory"
56928+ type: object
56929+ NetworkHealthInsightCategory:
56930+ description: |-
56931+ Category of network health insight. Indicates whether the insight relates to a DNS issue (`dns`),
56932+ a TCP issue (`tcp`), a TLS certificate issue (`tls-cert`), or a security group denial (`security-group`).
56933+ enum:
56934+ - dns
56935+ - tcp
56936+ - tls-cert
56937+ - security-group
56938+ example: dns
56939+ type: string
56940+ x-enum-varnames:
56941+ - DNS
56942+ - TCP
56943+ - TLS_CERT
56944+ - SECURITY_GROUP
56945+ NetworkHealthInsightFailureType:
56946+ description: |-
56947+ Specific failure type within the insight category. For DNS insights: `timeout`, `nxdomain`,
56948+ `servfail`, or `general_failure`. For TLS certificate insights: `expired` or `expiring_soon`.
56949+ For security group insights: `denied`.
56950+ enum:
56951+ - timeout
56952+ - nxdomain
56953+ - servfail
56954+ - general_failure
56955+ - expired
56956+ - expiring_soon
56957+ - denied
56958+ example: nxdomain
56959+ type: string
56960+ x-enum-varnames:
56961+ - TIMEOUT
56962+ - NXDOMAIN
56963+ - SERVFAIL
56964+ - GENERAL_FAILURE
56965+ - EXPIRED
56966+ - EXPIRING_SOON
56967+ - DENIED
56968+ NetworkHealthInsightTrafficVolume:
56969+ description: Network traffic volume metrics between the client and server services during the query window.
56970+ properties:
56971+ bytes_read:
56972+ description: Total bytes read from the server to the client during the query window.
56973+ example: 1800000
56974+ format: int64
56975+ type: integer
56976+ bytes_written:
56977+ description: Total bytes written from the client to the server during the query window.
56978+ example: 2500000
56979+ format: int64
56980+ type: integer
56981+ total_traffic:
56982+ description: Sum of bytes written and bytes read across the query window.
56983+ example: 4300000
56984+ format: int64
56985+ type: integer
56986+ type: object
56987+ NetworkHealthInsightsResponse:
56988+ description: Response containing a list of network health insights for the organization.
56989+ properties:
56990+ data:
56991+ description: Array of network health insights returned for the query window.
56992+ items:
56993+ $ref: "#/components/schemas/NetworkHealthInsight"
56994+ type: array
56995+ required:
56996+ - data
56997+ type: object
56998+ NetworkHealthInsightsType:
56999+ default: network-health-insights
57000+ description: The resource type for network health insights. Always `network-health-insights`.
57001+ enum:
57002+ - network-health-insights
57003+ example: network-health-insights
57004+ type: string
57005+ x-enum-varnames:
57006+ - NETWORK_HEALTH_INSIGHTS
5682257007 NodeType:
5682357008 additionalProperties: {}
5682457009 description: A tree-sitter node type definition for a given language, describing the node's structure, subtypes, and fields.
@@ -141152,6 +141337,118 @@ paths:
141152141337 summary: Update the tags for an interface
141153141338 tags:
141154141339 - Network Device Monitoring
141340+ /api/v2/network-health-insights:
141341+ get:
141342+ description: |-
141343+ Return network health insights for the organization within the given time window.
141344+ Insights are produced by analyzing DNS failures pre-classified by `network-dns-logger`,
141345+ TLS certificate metrics, and denied security group connections. Each insight
141346+ identifies the client and server services involved, the type of issue, and the
141347+ magnitude of the failure observed during the query window.
141348+ operationId: ListNetworkHealthInsights
141349+ parameters:
141350+ - description: |-
141351+ Unix timestamp (number of seconds since epoch) of the start of the query window.
141352+ If not provided, the start of the query window will be 15 minutes before the `to` timestamp.
141353+ If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
141354+ example: "1716800000"
141355+ in: query
141356+ name: from
141357+ required: false
141358+ schema:
141359+ type: string
141360+ - description: |-
141361+ Unix timestamp (number of seconds since epoch) of the end of the query window.
141362+ If not provided, the end of the query window will be the current time.
141363+ If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
141364+ example: "1716800900"
141365+ in: query
141366+ name: to
141367+ required: false
141368+ schema:
141369+ type: string
141370+ responses:
141371+ "200":
141372+ content:
141373+ application/json:
141374+ examples:
141375+ default:
141376+ value:
141377+ data:
141378+ - attributes:
141379+ client_service: "network-logger"
141380+ dns_query: "kafka-broker.internal.domain.com"
141381+ dns_server: "cluster-dns"
141382+ failure_magnitude: 150
141383+ failure_rate: 91
141384+ failure_type: "nxdomain"
141385+ server_service: "kafka"
141386+ total_requests: 1200
141387+ traffic_volume:
141388+ bytes_read: 1800000
141389+ bytes_written: 2500000
141390+ total_traffic: 4300000
141391+ type: "dns"
141392+ id: "example-insight-id"
141393+ type: "network-health-insights"
141394+ - attributes:
141395+ account_id: "123456789012"
141396+ certificate_id: "arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-a123-456b-a123-12345678901f"
141397+ certificate_lifetime_percent: 96.7
141398+ client_region: "us-west-2"
141399+ client_service: "N/A"
141400+ days_until_expiration: 3
141401+ domain_name: "api.example.com"
141402+ failure_type: "expiring_soon"
141403+ loadbalancer_id: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188"
141404+ server_region: "us-east-1"
141405+ server_service: "web-frontend"
141406+ type: "tls-cert"
141407+ id: "example-cert-insight-id"
141408+ type: "network-health-insights"
141409+ - attributes:
141410+ client_service: "web-frontend"
141411+ failure_magnitude: 85
141412+ failure_rate: 68.5
141413+ failure_type: "denied"
141414+ server_service: "database"
141415+ total_requests: 124
141416+ type: "security-group"
141417+ id: "example-security-group-insight-id"
141418+ type: "network-health-insights"
141419+ schema:
141420+ $ref: "#/components/schemas/NetworkHealthInsightsResponse"
141421+ description: OK
141422+ "400":
141423+ content:
141424+ application/json:
141425+ schema:
141426+ $ref: "#/components/schemas/JSONAPIErrorResponse"
141427+ description: Bad Request
141428+ "403":
141429+ content:
141430+ application/json:
141431+ schema:
141432+ $ref: "#/components/schemas/JSONAPIErrorResponse"
141433+ description: Forbidden
141434+ "429":
141435+ $ref: "#/components/responses/TooManyRequestsResponse"
141436+ "500":
141437+ content:
141438+ application/json:
141439+ schema:
141440+ $ref: "#/components/schemas/JSONAPIErrorResponse"
141441+ description: Internal Server Error
141442+ summary: List network health insights
141443+ tags:
141444+ - Network Health Insights
141445+ x-permission:
141446+ operator: OR
141447+ permissions:
141448+ - network_health_insights_read
141449+ x-unstable: |-
141450+ **Note**: This endpoint is in preview and is subject to change.
141451+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
141155141452 /api/v2/network/connections/aggregate:
141156141453 get:
141157141454 description: Get all aggregated connections.
@@ -176392,6 +176689,11 @@ tags:
176392176689 - description: |-
176393176690 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.
176394176691 name: Network Device Monitoring
176692+ - description: |-
176693+ Analyze network health by surfacing actionable insights for services experiencing connectivity issues.
176694+ Insights are derived from DNS failure data (timeouts, NXDOMAIN, SERVFAIL, general failures),
176695+ TLS certificate health (expired, expiring soon), and security group denials.
176696+ name: Network Health Insights
176395176697 - description: |-
176396176698 Configure OAuth2 clients for Datadog.
176397176699 Supports RFC 7591 Dynamic Client Registration and management of OAuth2 client scopes restrictions.
0 commit comments