Skip to content

Commit a99de15

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit f4bff5f of spec repo
1 parent 464a0fd commit a99de15

17 files changed

Lines changed: 998 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 302 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
@@ -147560,6 +147745,118 @@ paths:
147560147745
summary: Update the tags for an interface
147561147746
tags:
147562147747
- Network Device Monitoring
147748+
/api/v2/network-health-insights:
147749+
get:
147750+
description: |-
147751+
Return network health insights for the organization within the given time window.
147752+
Insights are produced by analyzing DNS failures pre-classified by `network-dns-logger`,
147753+
TLS certificate metrics, and denied security group connections. Each insight
147754+
identifies the client and server services involved, the type of issue, and the
147755+
magnitude of the failure observed during the query window.
147756+
operationId: ListNetworkHealthInsights
147757+
parameters:
147758+
- description: |-
147759+
Unix timestamp (number of seconds since epoch) of the start of the query window.
147760+
If not provided, the start of the query window will be 15 minutes before the `to` timestamp.
147761+
If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
147762+
example: "1716800000"
147763+
in: query
147764+
name: from
147765+
required: false
147766+
schema:
147767+
type: string
147768+
- description: |-
147769+
Unix timestamp (number of seconds since epoch) of the end of the query window.
147770+
If not provided, the end of the query window will be the current time.
147771+
If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.
147772+
example: "1716800900"
147773+
in: query
147774+
name: to
147775+
required: false
147776+
schema:
147777+
type: string
147778+
responses:
147779+
"200":
147780+
content:
147781+
application/json:
147782+
examples:
147783+
default:
147784+
value:
147785+
data:
147786+
- attributes:
147787+
client_service: "network-logger"
147788+
dns_query: "kafka-broker.internal.domain.com"
147789+
dns_server: "cluster-dns"
147790+
failure_magnitude: 150
147791+
failure_rate: 91
147792+
failure_type: "nxdomain"
147793+
server_service: "kafka"
147794+
total_requests: 1200
147795+
traffic_volume:
147796+
bytes_read: 1800000
147797+
bytes_written: 2500000
147798+
total_traffic: 4300000
147799+
type: "dns"
147800+
id: "example-insight-id"
147801+
type: "network-health-insights"
147802+
- attributes:
147803+
account_id: "123456789012"
147804+
certificate_id: "arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-a123-456b-a123-12345678901f"
147805+
certificate_lifetime_percent: 96.7
147806+
client_region: "us-west-2"
147807+
client_service: "N/A"
147808+
days_until_expiration: 3
147809+
domain_name: "api.example.com"
147810+
failure_type: "expiring_soon"
147811+
loadbalancer_id: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188"
147812+
server_region: "us-east-1"
147813+
server_service: "web-frontend"
147814+
type: "tls-cert"
147815+
id: "example-cert-insight-id"
147816+
type: "network-health-insights"
147817+
- attributes:
147818+
client_service: "web-frontend"
147819+
failure_magnitude: 85
147820+
failure_rate: 68.5
147821+
failure_type: "denied"
147822+
server_service: "database"
147823+
total_requests: 124
147824+
type: "security-group"
147825+
id: "example-security-group-insight-id"
147826+
type: "network-health-insights"
147827+
schema:
147828+
$ref: "#/components/schemas/NetworkHealthInsightsResponse"
147829+
description: OK
147830+
"400":
147831+
content:
147832+
application/json:
147833+
schema:
147834+
$ref: "#/components/schemas/JSONAPIErrorResponse"
147835+
description: Bad Request
147836+
"403":
147837+
content:
147838+
application/json:
147839+
schema:
147840+
$ref: "#/components/schemas/JSONAPIErrorResponse"
147841+
description: Forbidden
147842+
"429":
147843+
$ref: "#/components/responses/TooManyRequestsResponse"
147844+
"500":
147845+
content:
147846+
application/json:
147847+
schema:
147848+
$ref: "#/components/schemas/JSONAPIErrorResponse"
147849+
description: Internal Server Error
147850+
summary: List network health insights
147851+
tags:
147852+
- Network Health Insights
147853+
x-permission:
147854+
operator: OR
147855+
permissions:
147856+
- network_health_insights_read
147857+
x-unstable: |-
147858+
**Note**: This endpoint is in preview and is subject to change.
147859+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147563147860
/api/v2/network/connections/aggregate:
147564147861
get:
147565147862
description: Get all aggregated connections.
@@ -184659,6 +184956,11 @@ tags:
184659184956
- description: |-
184660184957
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.
184661184958
name: Network Device Monitoring
184959+
- description: |-
184960+
Analyze network health by surfacing actionable insights for services experiencing connectivity issues.
184961+
Insights are derived from DNS failure data (timeouts, NXDOMAIN, SERVFAIL, general failures),
184962+
TLS certificate health (expired, expiring soon), and security group denials.
184963+
name: Network Health Insights
184662184964
- description: |-
184663184965
Configure OAuth2 clients for Datadog.
184664184966
Supports RFC 7591 Dynamic Client Registration and management of OAuth2 client scopes restrictions.

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,13 @@ datadog\_api\_client.v2.api.network\_device\_monitoring\_api module
515515
:members:
516516
:show-inheritance:
517517

518+
datadog\_api\_client.v2.api.network\_health\_insights\_api module
519+
-----------------------------------------------------------------
520+
521+
.. automodule:: datadog_api_client.v2.api.network_health_insights_api
522+
:members:
523+
:show-inheritance:
524+
518525
datadog\_api\_client.v2.api.o\_auth2\_client\_public\_api module
519526
----------------------------------------------------------------
520527

docs/datadog_api_client.v2.model.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24658,6 +24658,55 @@ datadog\_api\_client.v2.model.ndk\_sourcemap\_data module
2465824658
:members:
2465924659
:show-inheritance:
2466024660

24661+
datadog\_api\_client.v2.model.network\_health\_insight module
24662+
-------------------------------------------------------------
24663+
24664+
.. automodule:: datadog_api_client.v2.model.network_health_insight
24665+
:members:
24666+
:show-inheritance:
24667+
24668+
datadog\_api\_client.v2.model.network\_health\_insight\_attributes module
24669+
-------------------------------------------------------------------------
24670+
24671+
.. automodule:: datadog_api_client.v2.model.network_health_insight_attributes
24672+
:members:
24673+
:show-inheritance:
24674+
24675+
datadog\_api\_client.v2.model.network\_health\_insight\_category module
24676+
-----------------------------------------------------------------------
24677+
24678+
.. automodule:: datadog_api_client.v2.model.network_health_insight_category
24679+
:members:
24680+
:show-inheritance:
24681+
24682+
datadog\_api\_client.v2.model.network\_health\_insight\_failure\_type module
24683+
----------------------------------------------------------------------------
24684+
24685+
.. automodule:: datadog_api_client.v2.model.network_health_insight_failure_type
24686+
:members:
24687+
:show-inheritance:
24688+
24689+
datadog\_api\_client.v2.model.network\_health\_insight\_traffic\_volume module
24690+
------------------------------------------------------------------------------
24691+
24692+
.. automodule:: datadog_api_client.v2.model.network_health_insight_traffic_volume
24693+
:members:
24694+
:show-inheritance:
24695+
24696+
datadog\_api\_client.v2.model.network\_health\_insights\_response module
24697+
------------------------------------------------------------------------
24698+
24699+
.. automodule:: datadog_api_client.v2.model.network_health_insights_response
24700+
:members:
24701+
:show-inheritance:
24702+
24703+
datadog\_api\_client.v2.model.network\_health\_insights\_type module
24704+
--------------------------------------------------------------------
24705+
24706+
.. automodule:: datadog_api_client.v2.model.network_health_insights_type
24707+
:members:
24708+
:show-inheritance:
24709+
2466124710
datadog\_api\_client.v2.model.node\_type module
2466224711
-----------------------------------------------
2466324712

0 commit comments

Comments
 (0)