8000 Adding endpoints to manage Resource Evaluation Filters (#29304) · DataDog/documentation@1cf6af2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1cf6af2

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Adding endpoints to manage Resource Evaluation Filters (#29304)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent c172838 commit 1cf6af2

File tree

9 files changed

+2769
-268
lines changed

9 files changed

+2769
-268
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-05-19 17:47:22.310341",
8-
"spec_repo_commit": "77e5efb9"
7+
"regenerated": "2025-05-20 07:23:31.781659",
8+
"spec_repo_commit": "fec20f97"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-19 17:47:31.365254",
13-
"spec_repo_commit": "77e5efb9"
12+
"regenerated": "2025-05-20 07:23:40.945974",
13+
"spec_repo_commit": "fec20f97"
1414
}
1515
}
1616
}

‎config/_default/menus/api.en.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2863,6 +2863,30 @@ menu:
28632863
unstable:
28642864
- v2
28652865
order: 1
2866+
- name: Update resource filters
2867+
url: '#update-resource-filters'
2868+
identifier: security-monitoring-update-resource-filters
2869+
parent: security-monitoring
2870+
generated: true
2871+
params:
2872+
versions:
2873+
- v2
2874+
operationids:
2875+
- UpdateResourceEvaluationFilters
2876+
unstable: []
2877+
order: 27
2878+
- name: List resource filters
2879+
url: '#list-resource-filters'
2880+
identifier: security-monitoring-list-resource-filters
2881+
parent: security-monitoring
2882+
generated: true
2883+
params:
2884+
versions:
2885+
- v2
2886+
operationids:
2887+
- GetResourceEvaluationFilters
2888+
unstable: []
2889+
order: 26
28662890
- name: Update a custom framework
28672891
url: '#update-a-custom-framework'
28682892
identifier: security-monitoring-update-a-custom-framework

‎content/en/api/v2/security-monitoring/examples.json

Lines changed: 140 additions & 14 deletions
Large diffs are not rendered by default.

‎content/en/api/v2/security-monitoring/request.UpdateResourceEvaluationFilters.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"data": {
3+
"attributes": {
4+
"cloud_provider": {
5+
"aws": {
6+
"aws_account_id": [
7+
"tag1:v1"
8+
]
9+
}
10+
}
11+
},
12+
"id": "csm_resource_filter",
13+
"type": "csm_resource_filter"
14+
}
15+
}

‎data/api/v2/CodeExamples.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1256,6 +1256,13 @@
12561256
"description": "Update a suppression rule returns \"OK\" response"
12571257
}
12581258
],
1259+
"UpdateResourceEvaluationFilters": [
1260+
{
1261+
"group": "security_monitoring",
1262+
"suffix": "",
1263+
"description": "Update resource filters returns \"OK\" response"
1264+
}
1265+
],
12591266
"ValidateSecurityMonitoringRule": [
12601267
{
12611268
"group": "security_monitoring",

‎data/api/v2/full_spec.yaml

Lines changed: 211 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -687,6 +687,21 @@ components:
687687
required: true
688688
schema:
689689
type: string
690+
ResourceFilterAccountID:
691+
description: Filter resource filters by cloud provider account ID. This parameter
692+
is only valid when provider is specified.
693+
in: query
694+
name: account_id
695+
required: false
696+
schema:
697+
type: string
698+
ResourceFilterProvider:
699+
description: Filter resource filters by cloud provider (e.g. aws, gcp, azure).
700+
in: query
701+
name: cloud_provider
702+
required: false
703+
schema:
704+
type: string
690705
ResourceID:
691706
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
692707
`dashboard`, `integration-account`, `integration-service`, `integration-webhook`,
@@ -826,6 +841,13 @@ components:
826841
required: true
827842
schema:
828843
type: string
844+
SkipCache:
845+
description: Skip cache for resource filters.
846+
in: query
847+
name: skip_cache
848+
required: false
849+
schema:
850+
type: boolean
829851
SpansMetricIDParameter:
830852
description: The name of the span-based metric.
831853
in: path
@@ -15833,6 +15855,26 @@ components:
1583315855
$ref: '#/components/schemas/GetInterfacesData'
1583415856
type: array
1583515857
type: object
15858+
GetResourceEvaluationFiltersResponse:
15859+
description: The definition of `GetResourceEvaluationFiltersResponse` object.
15860+
properties:
15861+
data:
15862+
$ref: '#/components/schemas/GetResourceEvaluationFiltersResponseData'
15863+
required:
15864+
- data
15865+
type: object
15866+
GetResourceEvaluationFiltersResponseData:
15867+
description: The definition of `GetResourceFilterResponseData` object.
15868+
properties:
15869+
attributes:
15870+
$ref: '#/components/schemas/ResourceFilterAttributes'
15871+
id:
15872+
description: The `data` `id`.
15873+
example: csm_resource_filter
15874+
type: string
15875+
type:
15876+
$ref: '#/components/schemas/ResourceFilterRequestType'
15877+
type: object
1583615878
GetRuleVersionHistoryData:
1583715879
description: Data for the rule version history.
1583815880
properties:
@@ -29747,6 +29789,46 @@ components:
2974729789
required:
2974829790
- data
2974929791
type: object
29792+
ResourceFilterAttributes:
29793+
description: Attributes of a resource filter.
29794+
example:
29795+
aws:
29796+
'123456789':
29797+
- environment:production
29798+
- team:devops
29799+
azure:
29800+
sub-001:
29801+
- app:frontend
29802+
gcp:
29803+
project-abc:
29804+
- region:us-central1
29805+
properties:
29806+
cloud_provider:
29807+
additionalProperties:
29808+
additionalProperties:
29809+
items:
29810+
description: Tag filter in format "key:value"
29811+
example: environment:production
29812+
type: string
29813+
type: array
29814+
type: object
29815+
description: A map of cloud provider names (e.g., "aws", "gcp", "azure")
29816+
to a map of account/resource IDs and their associated tag filters.
29817+
type: object
29818+
uuid:
29819+
description: The UUID of the resource filter.
29820+
type: string
29821+
required:
29822+
- cloud_provider
29823+
type: object
29824+
ResourceFilterRequestType:
29825+
description: Constant string to identify the request type.
29826+
enum:
29827+
- csm_resource_filter
29828+
example: csm_resource_filter
29829+
type: string
29830+
x-enum-varnames:
29831+
- CSM_RESOURCE_FILTER
2975029832
ResponseMetaAttributes:
2975129833
description: Object describing meta attributes of response.
2975229834
properties:
@@ -32909,9 +32991,11 @@ components:
3290932991
example: true
3291032992
type: boolean
3291132993
SecurityMonitoringRuleKeepAlive:
32912-
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
32913-
if a case is matched at least once within\nthis keep alive window. For third
32914-
party detection method, this field is not used."
32994+
description: 'Once a signal is generated, the signal will remain "open" if a
32995+
case is matched at least once within
32996+
32997+
this keep alive window. For third party detection method, this field is not
32998+
used.'
3291532999
enum:
3291633000
- 0
3291733001
- 60
@@ -32941,9 +33025,10 @@ components:
3294133025
- TWELVE_HOURS
3294233026
- ONE_DAY
3294333027
SecurityMonitoringRuleMaxSignalDuration:
32944-
description: "A signal will \u201Cclose\u201D regardless of the query being
32945-
matched once the time exceeds the maximum duration.\nThis time is calculated
32946-
from the first seen timestamp."
33028+
description: 'A signal will "close" regardless of the query being matched once
33029+
the time exceeds the maximum duration.
33030+
33031+
This time is calculated from the first seen timestamp.'
3294733032
enum:
3294833033
- 0
3294933034
- 60
@@ -39352,6 +39437,52 @@ components:
3935239437
id:
3935339438
$ref: '#/components/schemas/ApiID'
3935439439
type: object
39440+
UpdateResourceEvaluationFiltersRequest:
39441+
description: Request object to update a resource filter.
39442+
properties:
39443+
data:
39444+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequestData'
39445+
required:
39446+
- data
39447+
type: object
39448+
UpdateResourceEvaluationFiltersRequestData:
39449+
description: The definition of `UpdateResourceFilterRequestData` object.
39450+
properties:
39451+
attributes:
39452+
$ref: '#/components/schemas/ResourceFilterAttributes'
39453+
id:
39454+
description: The `UpdateResourceEvaluationFiltersRequestData` `id`.
39455+
example: csm_resource_filter
39456+
type: string
39457+
type:
39458+
$ref: '#/components/schemas/ResourceFilterRequestType'
39459+
required:
39460+
- attributes
39461+
- type
39462+
type: object
39463+
UpdateResourceEvaluationFiltersResponse:
39464+
description: The definition of `UpdateResourceEvaluationFiltersResponse` object.
39465+
properties:
39466+
data:
39467+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponseData'
39468+
required:
39469+
- data
39470+
type: object
39471+
UpdateResourceEvaluationFiltersResponseData:
39472+
description: The definition of `UpdateResourceFilterResponseData` object.
39473+
properties:
39474+
attributes:
39475+
$ref: '#/components/schemas/ResourceFilterAttributes'
39476+
id:
39477+
description: The `data` `id`.
39478+
example: csm_resource_filter
39479+
type: string
39480+
type:
39481+
$ref: '#/components/schemas/ResourceFilterRequestType'
39482+
required:
39483+
- attributes
39484+
- type
39485+
type: object
3935539486
UpdateRuleRequest:
3935639487
description: Request to update a scorecard rule.
3935739488
properties:
@@ -44746,6 +44877,80 @@ paths:
4474644877
- security_monitoring_rules_write
4474744878
x-undo:
4474844879
type: idempotent
44880+
/api/v2/cloud_security_management/resource_filters:
44881+
get:
44882+
description: List resource filters.
44883+
operationId: GetResourceEvaluationFilters
44884+
parameters:
44885+
- $ref: '#/components/parameters/ResourceFilterProvider'
44886+
- $ref: '#/components/parameters/ResourceFilterAccountID'
44887+
- $ref: '#/components/parameters/SkipCache'
44888+
responses:
44889+
'200':
44890+
content:
44891+
application/json:
44892+
schema:
44893+
$ref: '#/components/schemas/GetResourceEvaluationFiltersResponse'
44894+
description: OK
44895+
'400':
44896+
$ref: '#/components/responses/BadRequestResponse'
44897+
'403':
44898+
$ref: '#/components/responses/NotAuthorizedResponse'
44899+
'429':
44900+
$ref: '#/components/responses/TooManyRequestsResponse'
44901+
security:
44902+
- apiKeyAuth: []
44903+
appKeyAuth: []
44904+
- AuthZ:
44905+
- security_monitoring_filters_read
44906+
summary: List resource filters
44907+
tags:
44908+
- Security Monitoring
44909+
x-menu-order: 26
44910+
x-permission:
44911+
operator: OR
44912+
permissions:
44913+
- security_monitoring_filters_read
44914+
x-undo:
44915+
type: safe
44916+
put:
44917+
description: Update resource filters.
44918+
operationId: UpdateResourceEvaluationFilters
44919+
requestBody:
44920+
content:
44921+
application/json:
44922+
schema:
44923+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequest'
44924+
required: true
44925+
responses:
44926+
'201':
44927+
content:
44928+
application/json:
44929+
schema:
44930+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponse'
44931+
description: OK
44932+
'400':
44933+
$ref: '#/components/responses/BadRequestResponse'
44934+
'403':
44935+
$ref: '#/components/responses/NotAuthorizedResponse'
44936+
'429':
44937+
$ref: '#/components/responses/TooManyRequestsResponse'
44938+
security:
44939+
- apiKeyAuth: []
44940+
appKeyAuth: []
44941+
- AuthZ:
44942+
- security_monitoring_filters_write
44943+
summary: Update resource filters
44944+
tags:
44945+
- Security Monitoring
44946+
x-codegen-request-body-name: body
44947+
x-menu-order: 27
44948+
x-permission:
44949+
operator: OR
44950+
permissions:
44951+
- security_monitoring_filters_write
44952+
x-undo:
44953+
type: idempotent
4474944954
/api/v2/container_images:
4475044955
get:
4475144956
description: Get all Container Images for your organization.

0 commit comments

Comments
 (0)
0