Skip to content

Commit 327e1b6

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 2e491415 of spec repo (#2392)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 53deedb commit 327e1b6

File tree

14 files changed

+519
-4
lines changed

14 files changed

+519
-4
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-06-23 07:59:25.289975",
8-
"spec_repo_commit": "74866a53"
7+
"regenerated": "2025-06-23 13:26:53.358816",
8+
"spec_repo_commit": "2e491415"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-23 07:59:25.307606",
13-
"spec_repo_commit": "74866a53"
12+
"regenerated": "2025-06-23 13:26:53.376995",
13+
"spec_repo_commit": "2e491415"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10590,6 +10590,7 @@ components:
1059010590
- $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp'
1059110591
- $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk'
1059210592
- $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch'
10593+
- $ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinel'
1059310594
CustomDestinationForwardDestinationElasticsearch:
1059410595
description: The Elasticsearch destination.
1059510596
properties:
@@ -10674,6 +10675,49 @@ components:
1067410675
type: string
1067510676
x-enum-varnames:
1067610677
- HTTP
10678+
CustomDestinationForwardDestinationMicrosoftSentinel:
10679+
description: The Microsoft Sentinel destination.
10680+
properties:
10681+
client_id:
10682+
description: Client ID from the Datadog Azure integration.
10683+
example: 9a2f4d83-2b5e-429e-a35a-2b3c4182db71
10684+
type: string
10685+
data_collection_endpoint:
10686+
description: Azure data collection endpoint.
10687+
example: https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com
10688+
type: string
10689+
data_collection_rule_id:
10690+
description: Azure data collection rule ID.
10691+
example: dcr-000a00a000a00000a000000aa000a0aa
10692+
type: string
10693+
stream_name:
10694+
description: Azure stream name.
10695+
example: Custom-MyTable
10696+
type: string
10697+
writeOnly: true
10698+
tenant_id:
10699+
description: Tenant ID from the Datadog Azure integration.
10700+
example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2
10701+
type: string
10702+
type:
10703+
$ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinelType'
10704+
required:
10705+
- type
10706+
- tenant_id
10707+
- client_id
10708+
- data_collection_endpoint
10709+
- data_collection_rule_id
10710+
- stream_name
10711+
type: object
10712+
CustomDestinationForwardDestinationMicrosoftSentinelType:
10713+
default: microsoft_sentinel
10714+
description: Type of the Microsoft Sentinel destination.
10715+
enum:
10716+
- microsoft_sentinel
10717+
example: microsoft_sentinel
10718+
type: string
10719+
x-enum-varnames:
10720+
- MICROSOFT_SENTINEL
1067710721
CustomDestinationForwardDestinationSplunk:
1067810722
description: The Splunk HTTP Event Collector (HEC) destination.
1067910723
properties:
@@ -10849,6 +10893,7 @@ components:
1084910893
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
1085010894
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
1085110895
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
10896+
- $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinel'
1085210897
CustomDestinationResponseForwardDestinationElasticsearch:
1085310898
description: The Elasticsearch destination.
1085410899
properties:
@@ -10933,6 +10978,49 @@ components:
1093310978
type: string
1093410979
x-enum-varnames:
1093510980
- HTTP
10981+
CustomDestinationResponseForwardDestinationMicrosoftSentinel:
10982+
description: The Microsoft Sentinel destination.
10983+
properties:
10984+
client_id:
10985+
description: Client ID from the Datadog Azure integration.
10986+
example: 9a2f4d83-2b5e-429e-a35a-2b3c4182db71
10987+
type: string
10988+
data_collection_endpoint:
10989+
description: Azure data collection endpoint.
10990+
example: https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com
10991+
type: string
10992+
data_collection_rule_id:
10993+
description: Azure data collection rule ID.
10994+
example: dcr-000a00a000a00000a000000aa000a0aa
10995+
type: string
10996+
stream_name:
10997+
description: Azure stream name.
10998+
example: Custom-MyTable
10999+
type: string
11000+
writeOnly: true
11001+
tenant_id:
11002+
description: Tenant ID from the Datadog Azure integration.
11003+
example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2
11004+
type: string
11005+
type:
11006+
$ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinelType'
11007+
required:
11008+
- type
11009+
- tenant_id
11010+
- client_id
11011+
- data_collection_endpoint
11012+
- data_collection_rule_id
11013+
- stream_name
11014+
type: object
11015+
CustomDestinationResponseForwardDestinationMicrosoftSentinelType:
11016+
default: microsoft_sentinel
11017+
description: Type of the Microsoft Sentinel destination.
11018+
enum:
11019+
- microsoft_sentinel
11020+
example: microsoft_sentinel
11021+
type: string
11022+
x-enum-varnames:
11023+
- MICROSOFT_SENTINEL
1093611024
CustomDestinationResponseForwardDestinationSplunk:
1093711025
description: The Splunk HTTP Event Collector (HEC) destination.
1093811026
properties:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-06-20T08:10:33.243Z"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
{
2+
"log": {
3+
"_recordingName": "Logs Custom Destinations/Create a Microsoft Sentinel custom destination returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "42a16876edd11fd1384e5ef1ae5323d6",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 572,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 593,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"enabled\":false,\"forward_tags\":false,\"forward_tags_restriction_list\":[\"datacenter\",\"host\"],\"forward_tags_restriction_list_type\":\"ALLOW_LIST\",\"forwarder_destination\":{\"client_id\":\"9a2f4d83-2b5e-429e-a35a-2b3c4182db71\",\"data_collection_endpoint\":\"https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com\",\"data_collection_rule_id\":\"dcr-000a00a000a00000a000000aa000a0aa\",\"stream_name\":\"Custom-MyTable\",\"tenant_id\":\"f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2\",\"type\":\"microsoft_sentinel\"},\"name\":\"Nginx logs\",\"query\":\"source:nginx\"},\"type\":\"custom_destination\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/logs/config/custom-destinations"
39+
},
40+
"response": {
41+
"bodySize": 617,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 617,
45+
"text": "{\"data\":{\"id\":\"171ee4b7-e07f-43ca-85a5-23f762c161a7\",\"attributes\":{\"name\":\"Nginx logs\",\"query\":\"source:nginx\",\"enabled\":false,\"forwarder_destination\":{\"tenant_id\":\"f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2\",\"client_id\":\"9a2f4d83-2b5e-429e-a35a-2b3c4182db71\",\"data_collection_endpoint\":\"https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com\",\"data_collection_rule_id\":\"dcr-000a00a000a00000a000000aa000a0aa\",\"stream_name\":\"Custom-MyTable\",\"type\":\"microsoft_sentinel\"},\"forward_tags_restriction_list_type\":\"ALLOW_LIST\",\"forward_tags_restriction_list\":[\"datacenter\",\"host\"],\"forward_tags\":false},\"type\":\"custom_destination\"}}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 713,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2025-06-20T08:10:33.665Z",
61+
"time": 390
62+
},
63+
{
64+
"_id": "72747df2f798a86224387187f85ee17d",
65+
"_order": 0,
66+
"cache": {},
67+
"request": {
68+
"bodySize": 0,
69+
"cookies": [],
70+
"headers": [
71+
{
72+
"_fromType": "array",
73+
"name": "accept",
74+
"value": "*/*"
75+
}
76+
],
77+
"headersSize": 566,
78+
"httpVersion": "HTTP/1.1",
79+
"method": "DELETE",
80+
"queryString": [],
81+
"url": "https://api.datadoghq.com/api/v2/logs/config/custom-destinations/171ee4b7-e07f-43ca-85a5-23f762c161a7"
82+
},
83+
"response": {
84+
"bodySize": 0,
85+
"content": {
86+
"mimeType": "text/html; charset=utf-8",
87+
"size": 0
88+
},
89+
"cookies": [],
90+
"headers": [
91+
{
92+
"name": "content-type",
93+
"value": "text/html; charset=utf-8"
94+
}
95+
],
96+
"headersSize": 700,
97+
"httpVersion": "HTTP/1.1",
98+
"redirectURL": "",
99+
"status": 204,
100+
"statusText": "No Content"
101+
},
102+
"startedDateTime": "2025-06-20T08:10:34.069Z",
103+
"time": 388
104+
}
105+
],
106+
"pages": [],
107+
"version": "1.2"
108+
}
109+
}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/**
2+
* Create a Microsoft Sentinel custom destination returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.LogsCustomDestinationsApi(configuration);
9+
10+
const params: v2.LogsCustomDestinationsApiCreateLogsCustomDestinationRequest = {
11+
body: {
12+
data: {
13+
attributes: {
14+
enabled: false,
15+
forwardTags: false,
16+
forwardTagsRestrictionList: ["datacenter", "host"],
17+
forwardTagsRestrictionListType: "ALLOW_LIST",
18+
forwarderDestination: {
19+
type: "microsoft_sentinel",
20+
tenantId: "f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2",
21+
clientId: "9a2f4d83-2b5e-429e-a35a-2b3c4182db71",
22+
dataCollectionEndpoint:
23+
"https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com",
24+
dataCollectionRuleId: "dcr-000a00a000a00000a000000aa000a0aa",
25+
streamName: "Custom-MyTable",
26+
},
27+
name: "Nginx logs",
28+
query: "source:nginx",
29+
},
30+
type: "custom_destination",
31+
},
32+
},
33+
};
34+
35+
apiInstance
36+
.createLogsCustomDestination(params)
37+
.then((data: v2.CustomDestinationResponse) => {
38+
console.log(
39+
"API called successfully. Returned data: " + JSON.stringify(data)
40+
);
41+
})
42+
.catch((error: any) => console.error(error));

features/v2/logs_custom_destinations.feature

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,29 @@ Feature: Logs Custom Destinations
5757
And the response "data.attributes.forward_tags_restriction_list" array contains value "host"
5858
And the response "data.attributes.forward_tags_restriction_list_type" is equal to "ALLOW_LIST"
5959

60+
@team:DataDog/logs-backend @team:DataDog/logs-forwarding
61+
Scenario: Create a Microsoft Sentinel custom destination returns "OK" response
62+
Given new "CreateLogsCustomDestination" request
63+
And body with value {"data": {"attributes": {"enabled": false, "forward_tags": false, "forward_tags_restriction_list": ["datacenter", "host"], "forward_tags_restriction_list_type": "ALLOW_LIST", "forwarder_destination": {"type": "microsoft_sentinel", "tenant_id": "f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2", "client_id": "9a2f4d83-2b5e-429e-a35a-2b3c4182db71", "data_collection_endpoint": "https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com", "data_collection_rule_id": "dcr-000a00a000a00000a000000aa000a0aa", "stream_name": "Custom-MyTable"}, "name": "Nginx logs", "query": "source:nginx"}, "type": "custom_destination"}}
64+
When the request is sent
65+
Then the response status is 200 OK
66+
And the response "data.type" is equal to "custom_destination"
67+
And the response "data" has field "id"
68+
And the response "data.attributes.name" is equal to "Nginx logs"
69+
And the response "data.attributes.query" is equal to "source:nginx"
70+
And the response "data.attributes.forwarder_destination.type" is equal to "microsoft_sentinel"
71+
And the response "data.attributes.forwarder_destination.tenant_id" is equal to "f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2"
72+
And the response "data.attributes.forwarder_destination.client_id" is equal to "9a2f4d83-2b5e-429e-a35a-2b3c4182db71"
73+
And the response "data.attributes.forwarder_destination.data_collection_endpoint" is equal to "https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com"
74+
And the response "data.attributes.forwarder_destination.data_collection_rule_id" is equal to "dcr-000a00a000a00000a000000aa000a0aa"
75+
And the response "data.attributes.forwarder_destination.stream_name" is equal to "Custom-MyTable"
76+
And the response "data.attributes.enabled" is false
77+
And the response "data.attributes.forward_tags" is false
78+
And the response "data.attributes.forward_tags_restriction_list" has length 2
79+
And the response "data.attributes.forward_tags_restriction_list" array contains value "datacenter"
80+
And the response "data.attributes.forward_tags_restriction_list" array contains value "host"
81+
And the response "data.attributes.forward_tags_restriction_list_type" is equal to "ALLOW_LIST"
82+
6083
@team:DataDog/logs-backend @team:DataDog/logs-forwarding
6184
Scenario: Create a Splunk custom destination returns "OK" response
6285
Given new "CreateLogsCustomDestination" request

packages/datadog-api-client-v2/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1329,6 +1329,8 @@ export { CustomDestinationForwardDestinationElasticsearch } from "./models/Custo
13291329
export { CustomDestinationForwardDestinationElasticsearchType } from "./models/CustomDestinationForwardDestinationElasticsearchType";
13301330
export { CustomDestinationForwardDestinationHttp } from "./models/CustomDestinationForwardDestinationHttp";
13311331
export { CustomDestinationForwardDestinationHttpType } from "./models/CustomDestinationForwardDestinationHttpType";
1332+
export { CustomDestinationForwardDestinationMicrosoftSentinel } from "./models/CustomDestinationForwardDestinationMicrosoftSentinel";
1333+
export { CustomDestinationForwardDestinationMicrosoftSentinelType } from "./models/CustomDestinationForwardDestinationMicrosoftSentinelType";
13321334
export { CustomDestinationForwardDestinationSplunk } from "./models/CustomDestinationForwardDestinationSplunk";
13331335
export { CustomDestinationForwardDestinationSplunkType } from "./models/CustomDestinationForwardDestinationSplunkType";
13341336
export { CustomDestinationHttpDestinationAuth } from "./models/CustomDestinationHttpDestinationAuth";
@@ -1344,6 +1346,8 @@ export { CustomDestinationResponseForwardDestinationElasticsearch } from "./mode
13441346
export { CustomDestinationResponseForwardDestinationElasticsearchType } from "./models/CustomDestinationResponseForwardDestinationElasticsearchType";
13451347
export { CustomDestinationResponseForwardDestinationHttp } from "./models/CustomDestinationResponseForwardDestinationHttp";
13461348
export { CustomDestinationResponseForwardDestinationHttpType } from "./models/CustomDestinationResponseForwardDestinationHttpType";
1349+
export { CustomDestinationResponseForwardDestinationMicrosoftSentinel } from "./models/CustomDestinationResponseForwardDestinationMicrosoftSentinel";
1350+
export { CustomDestinationResponseForwardDestinationMicrosoftSentinelType } from "./models/CustomDestinationResponseForwardDestinationMicrosoftSentinelType";
13471351
export { CustomDestinationResponseForwardDestinationSplunk } from "./models/CustomDestinationResponseForwardDestinationSplunk";
13481352
export { CustomDestinationResponseForwardDestinationSplunkType } from "./models/CustomDestinationResponseForwardDestinationSplunkType";
13491353
export { CustomDestinationResponseHttpDestinationAuth } from "./models/CustomDestinationResponseHttpDestinationAuth";

packages/datadog-api-client-v2/models/CustomDestinationForwardDestination.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
import { CustomDestinationForwardDestinationElasticsearch } from "./CustomDestinationForwardDestinationElasticsearch";
77
import { CustomDestinationForwardDestinationHttp } from "./CustomDestinationForwardDestinationHttp";
8+
import { CustomDestinationForwardDestinationMicrosoftSentinel } from "./CustomDestinationForwardDestinationMicrosoftSentinel";
89
import { CustomDestinationForwardDestinationSplunk } from "./CustomDestinationForwardDestinationSplunk";
910

1011
import { UnparsedObject } from "../../datadog-api-client-common/util";
@@ -17,4 +18,5 @@ export type CustomDestinationForwardDestination =
1718
| CustomDestinationForwardDestinationHttp
1819
| CustomDestinationForwardDestinationSplunk
1920
| CustomDestinationForwardDestinationElasticsearch
21+
| CustomDestinationForwardDestinationMicrosoftSentinel
2022
| UnparsedObject;

0 commit comments

Comments
 (0)