Skip to content

Commit 41129f0

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 71a3f57 of spec repo
1 parent 19ed7da commit 41129f0

21 files changed

Lines changed: 2213 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1699,6 +1699,15 @@ components:
16991699
required: true
17001700
schema:
17011701
type: string
1702+
SecurityMonitoringRuleVersion:
1703+
description: The historical version number of the rule.
1704+
in: path
1705+
name: version
1706+
required: true
1707+
schema:
1708+
example: 1
1709+
format: int64
1710+
type: integer
17021711
SecurityMonitoringSuppressionID:
17031712
description: The ID of the suppression rule
17041713
in: path
@@ -28735,6 +28744,31 @@ components:
2873528744
- bucket_name
2873628745
- bucket_region
2873728746
type: object
28747+
DataObservabilityMonitorRunStatus:
28748+
description: The status of a data observability monitor run.
28749+
enum:
28750+
- pending
28751+
- ok
28752+
- warn
28753+
- alert
28754+
- error
28755+
example: pending
28756+
type: string
28757+
x-enum-varnames:
28758+
- PENDING
28759+
- OK
28760+
- WARN
28761+
- ALERT
28762+
- ERROR
28763+
DataObservabilityMonitorRunType:
28764+
default: monitor_run
28765+
description: The JSON:API resource type for a data observability monitor run.
28766+
enum:
28767+
- monitor_run
28768+
example: monitor_run
28769+
type: string
28770+
x-enum-varnames:
28771+
- MONITOR_RUN
2873828772
DataRelationshipsTeams:
2873928773
description: Associates teams with this schedule in a data structure.
2874028774
properties:
@@ -39045,6 +39079,42 @@ components:
3904539079
meta:
3904639080
$ref: "#/components/schemas/DataDeletionResponseMeta"
3904739081
type: object
39082+
GetDataObservabilityMonitorRunStatusResponse:
39083+
description: The response for getting the status of a data observability monitor run.
39084+
properties:
39085+
data:
39086+
$ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData"
39087+
required:
39088+
- data
39089+
type: object
39090+
GetDataObservabilityMonitorRunStatusResponseAttributes:
39091+
description: The attributes of a data observability monitor run status response.
39092+
properties:
39093+
error_message:
39094+
description: Error message describing why the monitor run failed. Only present when status is error.
39095+
example: "run completed but produced no metric data"
39096+
type: string
39097+
status:
39098+
$ref: "#/components/schemas/DataObservabilityMonitorRunStatus"
39099+
required:
39100+
- status
39101+
type: object
39102+
GetDataObservabilityMonitorRunStatusResponseData:
39103+
description: The data object for a data observability monitor run status response.
39104+
properties:
39105+
attributes:
39106+
$ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes"
39107+
id:
39108+
description: The unique identifier of the monitor run.
39109+
example: "abc123def456"
39110+
type: string
39111+
type:
39112+
$ref: "#/components/schemas/DataObservabilityMonitorRunType"
39113+
required:
39114+
- id
39115+
- type
39116+
- attributes
39117+
type: object
3904839118
GetDeviceAttributes:
3904939119
description: The device attributes
3905039120
properties:
@@ -77898,6 +77968,27 @@ components:
7789877968
$ref: "#/components/schemas/RumRetentionFilterData"
7789977969
type: array
7790077970
type: object
77971+
RunDataObservabilityMonitorResponse:
77972+
description: The response returned when a data observability monitor run is triggered.
77973+
properties:
77974+
data:
77975+
$ref: "#/components/schemas/RunDataObservabilityMonitorResponseData"
77976+
required:
77977+
- data
77978+
type: object
77979+
RunDataObservabilityMonitorResponseData:
77980+
description: The data object returned when a data observability monitor run is triggered.
77981+
properties:
77982+
id:
77983+
description: The unique identifier of the monitor run.
77984+
example: "abc123def456"
77985+
type: string
77986+
type:
77987+
$ref: "#/components/schemas/DataObservabilityMonitorRunType"
77988+
required:
77989+
- id
77990+
- type
77991+
type: object
7790177992
RunHistoricalJobRequest:
7790277993
description: Run a historical job request.
7790377994
properties:
@@ -124777,6 +124868,105 @@ paths:
124777124868
x-unstable: |-
124778124869
**Note**: This endpoint is in preview and is subject to change.
124779124870
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
124871+
/api/v2/data-observability/monitors/runs/{run_id}/status:
124872+
get:
124873+
description: Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.
124874+
operationId: GetDataObservabilityMonitorRunStatus
124875+
parameters:
124876+
- description: The ID of the monitor run to retrieve status for.
124877+
example: "abc123def456"
124878+
in: path
124879+
name: run_id
124880+
required: true
124881+
schema:
124882+
type: string
124883+
responses:
124884+
"200":
124885+
content:
124886+
application/json:
124887+
examples:
124888+
default:
124889+
value:
124890+
data:
124891+
attributes:
124892+
status: ok
124893+
id: "abc123def456"
124894+
type: monitor_run
124895+
schema:
124896+
$ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponse"
124897+
description: OK
124898+
"404":
124899+
content:
124900+
application/json:
124901+
schema:
124902+
$ref: "#/components/schemas/JSONAPIErrorResponse"
124903+
description: Not Found
124904+
"429":
124905+
$ref: "#/components/responses/TooManyRequestsResponse"
124906+
security:
124907+
- apiKeyAuth: []
124908+
appKeyAuth: []
124909+
- AuthZ:
124910+
- data_observability_monitors_write
124911+
- monitors_write
124912+
summary: Get data observability monitor run status
124913+
tags:
124914+
- Data Observability
124915+
x-unstable: |-
124916+
**Note**: This endpoint is in preview and is subject to change.
124917+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
124918+
/api/v2/data-observability/monitors/{monitor_id}/run:
124919+
post:
124920+
description: Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.
124921+
operationId: RunDataObservabilityMonitor
124922+
parameters:
124923+
- description: The ID of the data observability monitor to run.
124924+
example: 12345
124925+
in: path
124926+
name: monitor_id
124927+
required: true
124928+
schema:
124929+
format: int64
124930+
type: integer
124931+
responses:
124932+
"200":
124933+
content:
124934+
application/json:
124935+
examples:
124936+
default:
124937+
value:
124938+
data:
124939+
id: "abc123def456"
124940+
type: monitor_run
124941+
schema:
124942+
$ref: "#/components/schemas/RunDataObservabilityMonitorResponse"
124943+
description: OK
124944+
"400":
124945+
content:
124946+
application/json:
124947+
schema:
124948+
$ref: "#/components/schemas/JSONAPIErrorResponse"
124949+
description: Bad Request
124950+
"404":
124951+
content:
124952+
application/json:
124953+
schema:
124954+
$ref: "#/components/schemas/JSONAPIErrorResponse"
124955+
description: Not Found
124956+
"429":
124957+
$ref: "#/components/responses/TooManyRequestsResponse"
124958+
security:
124959+
- apiKeyAuth: []
124960+
appKeyAuth: []
124961+
- AuthZ:
124962+
- data_observability_monitors_write
124963+
- monitors_write
124964+
summary: Run a data observability monitor
124965+
tags:
124966+
- Data Observability
124967+
x-unstable: |-
124968+
**Note**: This endpoint is in preview and is subject to change.
124969+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
124780124970
/api/v2/datasets:
124781124971
get:
124782124972
description: Get all datasets that have been configured for an organization.
@@ -169731,6 +169921,60 @@ paths:
169731169921
operator: OR
169732169922
permissions:
169733169923
- security_monitoring_rules_read
169924+
/api/v2/security_monitoring/rules/{rule_id}/restore/{version}:
169925+
post:
169926+
description: |-
169927+
Restores a custom detection rule to a previously saved historical version.
169928+
Only custom rules can be restored. Default and partner rules return 400.
169929+
The restore creates a new version entry; it does not overwrite history.
169930+
operationId: RestoreSecurityMonitoringRule
169931+
parameters:
169932+
- $ref: "#/components/parameters/SecurityMonitoringRuleID"
169933+
- $ref: "#/components/parameters/SecurityMonitoringRuleVersion"
169934+
responses:
169935+
"200":
169936+
content:
169937+
"application/json":
169938+
examples:
169939+
default:
169940+
value:
169941+
cases:
169942+
- condition: "a > 0"
169943+
name: ""
169944+
notifications: []
169945+
status: info
169946+
id: abc-123
169947+
isEnabled: true
169948+
message: Test rule
169949+
name: My security monitoring rule.
169950+
tags: []
169951+
type: log_detection
169952+
schema:
169953+
$ref: "#/components/schemas/SecurityMonitoringRuleResponse"
169954+
description: OK
169955+
"400":
169956+
$ref: "#/components/responses/BadRequestResponse"
169957+
"403":
169958+
$ref: "#/components/responses/NotAuthorizedResponse"
169959+
"404":
169960+
$ref: "#/components/responses/NotFoundResponse"
169961+
"409":
169962+
$ref: "#/components/responses/ConflictResponse"
169963+
"429":
169964+
$ref: "#/components/responses/TooManyRequestsResponse"
169965+
security:
169966+
- apiKeyAuth: []
169967+
appKeyAuth: []
169968+
- AuthZ:
169969+
- security_monitoring_rules_write
169970+
summary: Restore a rule to a historical version
169971+
tags: ["Security Monitoring"]
169972+
"x-permission":
169973+
operator: OR
169974+
permissions:
169975+
- security_monitoring_rules_write
169976+
x-unstable: |-
169977+
**Note**: This endpoint is in beta and may be subject to changes.
169734169978
/api/v2/security_monitoring/rules/{rule_id}/test:
169735169979
post:
169736169980
description: |-
@@ -186518,6 +186762,8 @@ tags:
186518186762
- description: |-
186519186763
The Data Deletion API allows the user to target and delete data from the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data` and `rum_delete_data` permissions respectively.
186520186764
name: Data Deletion
186765+
- description: Manage and run data observability monitors.
186766+
name: Data Observability
186521186767
- description: |-
186522186768
Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate
186523186769
access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Restore a rule to a historical version returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
6+
import com.datadog.api.client.v2.model.SecurityMonitoringRuleResponse;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
defaultClient.setUnstableOperationEnabled("v2.restoreSecurityMonitoringRule", true);
12+
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
13+
14+
// there is a valid "security_rule" in the system
15+
String SECURITY_RULE_ID = System.getenv("SECURITY_RULE_ID");
16+
17+
try {
18+
SecurityMonitoringRuleResponse result =
19+
apiInstance.restoreSecurityMonitoringRule(SECURITY_RULE_ID, 1L);
20+
System.out.println(result);
21+
} catch (ApiException e) {
22+
System.err.println(
23+
"Exception when calling SecurityMonitoringApi#restoreSecurityMonitoringRule");
24+
System.err.println("Status code: " + e.getCode());
25+
System.err.println("Reason: " + e.getResponseBody());
26+
System.err.println("Response headers: " + e.getResponseHeaders());
27+
e.printStackTrace();
28+
}
29+
}
30+
}

src/main/java/com/datadog/api/client/ApiClient.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -944,6 +944,7 @@ public class ApiClient {
944944
put("v2.listVulnerabilities", false);
945945
put("v2.listVulnerableAssets", false);
946946
put("v2.muteFindings", false);
947+
put("v2.restoreSecurityMonitoringRule", false);
947948
put("v2.runHistoricalJob", false);
948949
put("v2.searchSecurityMonitoringHistsignals", false);
949950
put("v2.updateFindingsAssignee", false);
@@ -990,6 +991,8 @@ public class ApiClient {
990991
put("v2.updateDashboardSecureEmbed", false);
991992
put("v2.getDashboardUsage", false);
992993
put("v2.listDashboardsUsage", false);
994+
put("v2.getDataObservabilityMonitorRunStatus", false);
995+
put("v2.runDataObservabilityMonitor", false);
993996
put("v2.createDataset", false);
994997
put("v2.deleteDataset", false);
995998
put("v2.getAllDatasets", false);

0 commit comments

Comments
 (0)