Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions config/_default/menus/api.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3278,6 +3278,19 @@ menu:
- TestExistingSecurityMonitoringRule
unstable: []
order: 56
- name: Restore a rule to a historical version
url: /api/latest/security-monitoring/restore-a-rule-to-a-historical-version/
identifier: security-monitoring-restore-a-rule-to-a-historical-version
parent: security-monitoring
generated: true
params:
versions:
- v2
operationids:
- RestoreSecurityMonitoringRule
unstable:
- v2
order: 133
- name: Convert an existing rule from JSON to Terraform
url: /api/latest/security-monitoring/convert-an-existing-rule-from-json-to-terraform/
identifier: security-monitoring-convert-an-existing-rule-from-json-to-terraform
Expand Down Expand Up @@ -10931,6 +10944,36 @@ menu:
unstable:
- v2
order: 5
- name: Data Observability
url: /api/latest/data-observability/
identifier: data-observability
generated: true
- name: Run a data observability monitor
url: /api/latest/data-observability/run-a-data-observability-monitor/
identifier: data-observability-run-a-data-observability-monitor
parent: data-observability
generated: true
params:
versions:
- v2
operationids:
- RunDataObservabilityMonitor
unstable:
- v2
order: 1
- name: Get data observability monitor run status
url: /api/latest/data-observability/get-data-observability-monitor-run-status/
identifier: data-observability-get-data-observability-monitor-run-status
parent: data-observability
generated: true
params:
versions:
- v2
operationids:
- GetDataObservabilityMonitorRunStatus
unstable:
- v2
order: 2
- name: Datasets
url: /api/latest/datasets/
identifier: datasets
Expand Down
3 changes: 3 additions & 0 deletions content/en/api/latest/data-observability/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Data Observability
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Get data observability monitor run status
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Run a data observability monitor
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Restore a rule to a historical version
---
4 changes: 4 additions & 0 deletions content/en/api/v2/data-observability/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Data Observability
headless: true
---
112 changes: 112 additions & 0 deletions content/en/api/v2/data-observability/examples.json

Large diffs are not rendered by default.

217 changes: 217 additions & 0 deletions content/en/api/v2/security-monitoring/examples.json

Large diffs are not rendered by default.

249 changes: 249 additions & 0 deletions data/api/v2/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1685,6 +1685,15 @@ components:
required: true
schema:
type: string
SecurityMonitoringRuleVersion:
description: The historical version number of the rule.
in: path
name: version
required: true
schema:
example: 1
format: int64
type: integer
SecurityMonitoringSuppressionID:
description: The ID of the suppression rule
in: path
Expand Down Expand Up @@ -28523,6 +28532,31 @@ components:
- bucket_name
- bucket_region
type: object
DataObservabilityMonitorRunStatus:
description: The status of a data observability monitor run.
enum:
- pending
- ok
- warn
- alert
- error
example: pending
type: string
x-enum-varnames:
- PENDING
- OK
- WARN
- ALERT
- ERROR
DataObservabilityMonitorRunType:
default: monitor_run
description: The JSON:API resource type for a data observability monitor run.
enum:
- monitor_run
example: monitor_run
type: string
x-enum-varnames:
- MONITOR_RUN
DataRelationshipsTeams:
description: Associates teams with this schedule in a data structure.
properties:
Expand Down Expand Up @@ -39197,6 +39231,42 @@ components:
required:
- data
type: object
GetDataObservabilityMonitorRunStatusResponse:
description: The response for getting the status of a data observability monitor run.
properties:
data:
$ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData"
required:
- data
type: object
GetDataObservabilityMonitorRunStatusResponseAttributes:
description: The attributes of a data observability monitor run status response.
properties:
error_message:
description: Error message describing why the monitor run failed. Only present when status is error.
example: "run completed but produced no metric data"
type: string
status:
$ref: "#/components/schemas/DataObservabilityMonitorRunStatus"
required:
- status
type: object
GetDataObservabilityMonitorRunStatusResponseData:
description: The data object for a data observability monitor run status response.
properties:
attributes:
$ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes"
id:
description: The unique identifier of the monitor run.
example: "abc123def456"
type: string
type:
$ref: "#/components/schemas/DataObservabilityMonitorRunType"
required:
- id
- type
- attributes
type: object
GetDeviceAttributes:
description: The device attributes
properties:
Expand Down Expand Up @@ -78882,6 +78952,27 @@ components:
$ref: "#/components/schemas/RumRetentionFilterData"
type: array
type: object
RunDataObservabilityMonitorResponse:
description: The response returned when a data observability monitor run is triggered.
properties:
data:
$ref: "#/components/schemas/RunDataObservabilityMonitorResponseData"
required:
- data
type: object
RunDataObservabilityMonitorResponseData:
description: The data object returned when a data observability monitor run is triggered.
properties:
id:
description: The unique identifier of the monitor run.
example: "abc123def456"
type: string
type:
$ref: "#/components/schemas/DataObservabilityMonitorRunType"
required:
- id
- type
type: object
RunHistoricalJobRequest:
description: Run a historical job request.
properties:
Expand Down Expand Up @@ -126182,6 +126273,107 @@ paths:
x-unstable: |-
**Note**: This endpoint is in preview and is subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/data-observability/monitors/runs/{run_id}/status:
get:
description: Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.
operationId: GetDataObservabilityMonitorRunStatus
parameters:
- description: The ID of the monitor run to retrieve status for.
example: "abc123def456"
in: path
name: run_id
required: true
schema:
type: string
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
attributes:
status: ok
id: "abc123def456"
type: monitor_run
schema:
$ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponse"
description: OK
"404":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- data_observability_monitors_write
- monitors_write
summary: Get data observability monitor run status
tags:
- Data Observability
x-menu-order: 2
x-unstable: |-
**Note**: This endpoint is in preview and is subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/data-observability/monitors/{monitor_id}/run:
post:
description: Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.
operationId: RunDataObservabilityMonitor
parameters:
- description: The ID of the data observability monitor to run.
example: 12345
in: path
name: monitor_id
required: true
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
id: "abc123def456"
type: monitor_run
schema:
$ref: "#/components/schemas/RunDataObservabilityMonitorResponse"
description: OK
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Bad Request
"404":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- data_observability_monitors_write
- monitors_write
summary: Run a data observability monitor
tags:
- Data Observability
x-menu-order: 1
x-unstable: |-
**Note**: This endpoint is in preview and is subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/datasets:
get:
description: Get all datasets that have been configured for an organization.
Expand Down Expand Up @@ -172619,6 +172811,61 @@ paths:
operator: OR
permissions:
- security_monitoring_rules_read
/api/v2/security_monitoring/rules/{rule_id}/restore/{version}:
post:
description: |-
Restores a custom detection rule to a previously saved historical version.
Only custom rules can be restored. Default and partner rules return 400.
The restore creates a new version entry; it does not overwrite history.
operationId: RestoreSecurityMonitoringRule
parameters:
- $ref: "#/components/parameters/SecurityMonitoringRuleID"
- $ref: "#/components/parameters/SecurityMonitoringRuleVersion"
responses:
"200":
content:
"application/json":
examples:
default:
value:
cases:
- condition: "a > 0"
name: ""
notifications: []
status: info
id: abc-123
isEnabled: true
message: Test rule
name: My security monitoring rule.
tags: []
type: log_detection
schema:
$ref: "#/components/schemas/SecurityMonitoringRuleResponse"
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
"409":
$ref: "#/components/responses/ConflictResponse"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- security_monitoring_rules_write
summary: Restore a rule to a historical version
tags: ["Security Monitoring"]
x-menu-order: 133
"x-permission":
operator: OR
permissions:
- security_monitoring_rules_write
x-unstable: |-
**Note**: This endpoint is in beta and may be subject to changes.
/api/v2/security_monitoring/rules/{rule_id}/test:
post:
description: |-
Expand Down Expand Up @@ -189668,6 +189915,8 @@ tags:
[Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more
information.
name: Dashboards
- description: Manage and run data observability monitors.
name: Data Observability
- description: |-
Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate
access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can
Expand Down
Loading
Loading