Skip to content

Commit 5b33374

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Adding endpoints to manage Resource Evaluation Filters (#2567)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 9e6633c commit 5b33374

29 files changed

+979
-16
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:45:11.035218",
8-
"spec_repo_commit": "77e5efb9"
7+
"regenerated": "2025-05-20 07:21:28.312845",
8+
"spec_repo_commit": "fec20f97"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-19 17:45:11.092406",
13-
"spec_repo_commit": "77e5efb9"
12+
"regenerated": "2025-05-20 07:21:28.331470",
13+
"spec_repo_commit": "fec20f97"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 205 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -689,6 +689,21 @@ components:
689689
required: true
690690
schema:
691691
type: string
692+
ResourceFilterAccountID:
693+
description: Filter resource filters by cloud provider account ID. This parameter
694+
is only valid when provider is specified.
695+
in: query
696+
name: account_id
697+
required: false
698+
schema:
699+
type: string
700+
ResourceFilterProvider:
701+
description: Filter resource filters by cloud provider (e.g. aws, gcp, azure).
702+
in: query
703+
name: cloud_provider
704+
required: false
705+
schema:
706+
type: string
692707
ResourceID:
693708
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
694709
`dashboard`, `integration-account`, `integration-service`, `integration-webhook`,
@@ -807,6 +822,13 @@ components:
807822
required: true
808823
schema:
809824
type: string
825+
SkipCache:
826+
description: Skip cache for resource filters.
827+
in: query
828+
name: skip_cache
829+
required: false
830+
schema:
831+
type: boolean
810832
SpansMetricIDParameter:
811833
description: The name of the span-based metric.
812834
in: path
@@ -15715,6 +15737,26 @@ components:
1571515737
$ref: '#/components/schemas/GetInterfacesData'
1571615738
type: array
1571715739
type: object
15740+
GetResourceEvaluationFiltersResponse:
15741+
description: The definition of `GetResourceEvaluationFiltersResponse` object.
15742+
properties:
15743+
data:
15744+
$ref: '#/components/schemas/GetResourceEvaluationFiltersResponseData'
15745+
required:
15746+
- data
15747+
type: object
15748+
GetResourceEvaluationFiltersResponseData:
15749+
description: The definition of `GetResourceFilterResponseData` object.
15750+
properties:
15751+
attributes:
15752+
$ref: '#/components/schemas/ResourceFilterAttributes'
15753+
id:
15754+
description: The `data` `id`.
15755+
example: csm_resource_filter
15756+
type: string
15757+
type:
15758+
$ref: '#/components/schemas/ResourceFilterRequestType'
15759+
type: object
1571815760
GetRuleVersionHistoryData:
1571915761
description: Data for the rule version history.
1572015762
properties:
@@ -29270,6 +29312,46 @@ components:
2927029312
required:
2927129313
- data
2927229314
type: object
29315+
ResourceFilterAttributes:
29316+
description: Attributes of a resource filter.
29317+
example:
29318+
aws:
29319+
'123456789':
29320+
- environment:production
29321+
- team:devops
29322+
azure:
29323+
sub-001:
29324+
- app:frontend
29325+
gcp:
29326+
project-abc:
29327+
- region:us-central1
29328+
properties:
29329+
cloud_provider:
29330+
additionalProperties:
29331+
additionalProperties:
29332+
items:
29333+
description: Tag filter in format "key:value"
29334+
example: environment:production
29335+
type: string
29336+
type: array
29337+
type: object
29338+
description: A map of cloud provider names (e.g., "aws", "gcp", "azure")
29339+
to a map of account/resource IDs and their associated tag filters.
29340+
type: object
29341+
uuid:
29342+
description: The UUID of the resource filter.
29343+
type: string
29344+
required:
29345+
- cloud_provider
29346+
type: object
29347+
ResourceFilterRequestType:
29348+
description: Constant string to identify the request type.
29349+
enum:
29350+
- csm_resource_filter
29351+
example: csm_resource_filter
29352+
type: string
29353+
x-enum-varnames:
29354+
- CSM_RESOURCE_FILTER
2927329355
ResponseMetaAttributes:
2927429356
description: Object describing meta attributes of response.
2927529357
properties:
@@ -32253,9 +32335,11 @@ components:
3225332335
example: true
3225432336
type: boolean
3225532337
SecurityMonitoringRuleKeepAlive:
32256-
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
32257-
if a case is matched at least once within\nthis keep alive window. For third
32258-
party detection method, this field is not used."
32338+
description: 'Once a signal is generated, the signal will remain "open" if a
32339+
case is matched at least once within
32340+
32341+
this keep alive window. For third party detection method, this field is not
32342+
used.'
3225932343
enum:
3226032344
- 0
3226132345
- 60
@@ -32285,9 +32369,10 @@ components:
3228532369
- TWELVE_HOURS
3228632370
- ONE_DAY
3228732371
SecurityMonitoringRuleMaxSignalDuration:
32288-
description: "A signal will \u201Cclose\u201D regardless of the query being
32289-
matched once the time exceeds the maximum duration.\nThis time is calculated
32290-
from the first seen timestamp."
32372+
description: 'A signal will "close" regardless of the query being matched once
32373+
the time exceeds the maximum duration.
32374+
32375+
This time is calculated from the first seen timestamp.'
3229132376
enum:
3229232377
- 0
3229332378
- 60
@@ -38688,6 +38773,52 @@ components:
3868838773
id:
3868938774
$ref: '#/components/schemas/ApiID'
3869038775
type: object
38776+
UpdateResourceEvaluationFiltersRequest:
38777+
description: Request object to update a resource filter.
38778+
properties:
38779+
data:
38780+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequestData'
38781+
required:
38782+
- data
38783+
type: object
38784+
UpdateResourceEvaluationFiltersRequestData:
38785+
description: The definition of `UpdateResourceFilterRequestData` object.
38786+
properties:
38787+
attributes:
38788+
$ref: '#/components/schemas/ResourceFilterAttributes'
38789+
id:
38790+
description: The `UpdateResourceEvaluationFiltersRequestData` `id`.
38791+
example: csm_resource_filter
38792+
type: string
38793+
type:
38794+
$ref: '#/components/schemas/ResourceFilterRequestType'
38795+
required:
38796+
- attributes
38797+
- type
38798+
type: object
38799+
UpdateResourceEvaluationFiltersResponse:
38800+
description: The definition of `UpdateResourceEvaluationFiltersResponse` object.
38801+
properties:
38802+
data:
38803+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponseData'
38804+
required:
38805+
- data
38806+
type: object
38807+
UpdateResourceEvaluationFiltersResponseData:
38808+
description: The definition of `UpdateResourceFilterResponseData` object.
38809+
properties:
38810+
attributes:
38811+
$ref: '#/components/schemas/ResourceFilterAttributes'
38812+
id:
38813+
description: The `data` `id`.
38814+
example: csm_resource_filter
38815+
type: string
38816+
type:
38817+
$ref: '#/components/schemas/ResourceFilterRequestType'
38818+
required:
38819+
- attributes
38820+
- type
38821+
type: object
3869138822
UpdateRuleRequest:
3869238823
description: Request to update a scorecard rule.
3869338824
properties:
@@ -43624,6 +43755,74 @@ paths:
4362443755
permissions:
4362543756
- security_monitoring_rules_read
4362643757
- security_monitoring_rules_write
43758+
/api/v2/cloud_security_management/resource_filters:
43759+
get:
43760+
description: List resource filters.
43761+
operationId: GetResourceEvaluationFilters
43762+
parameters:
43763+
- $ref: '#/components/parameters/ResourceFilterProvider'
43764+
- $ref: '#/components/parameters/ResourceFilterAccountID'
43765+
- $ref: '#/components/parameters/SkipCache'
43766+
responses:
43767+
'200':
43768+
content:
43769+
application/json:
43770+
schema:
43771+
$ref: '#/components/schemas/GetResourceEvaluationFiltersResponse'
43772+
description: OK
43773+
'400':
43774+
$ref: '#/components/responses/BadRequestResponse'
43775+
'403':
43776+
$ref: '#/components/responses/NotAuthorizedResponse'
43777+
'429':
43778+
$ref: '#/components/responses/TooManyRequestsResponse'
43779+
security:
43780+
- apiKeyAuth: []
43781+
appKeyAuth: []
43782+
- AuthZ:
43783+
- security_monitoring_filters_read
43784+
summary: List resource filters
43785+
tags:
43786+
- Security Monitoring
43787+
x-permission:
43788+
operator: OR
43789+
permissions:
43790+
- security_monitoring_filters_read
43791+
put:
43792+
description: Update resource filters.
43793+
operationId: UpdateResourceEvaluationFilters
43794+
requestBody:
43795+
content:
43796+
application/json:
43797+
schema:
43798+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequest'
43799+
required: true
43800+
responses:
43801+
'201':
43802+
content:
43803+
application/json:
43804+
schema:
43805+
$ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponse'
43806+
description: OK
43807+
'400':
43808+
$ref: '#/components/responses/BadRequestResponse'
43809+
'403':
43810+
$ref: '#/components/responses/NotAuthorizedResponse'
43811+
'429':
43812+
$ref: '#/components/responses/TooManyRequestsResponse'
43813+
security:
43814+
- apiKeyAuth: []
43815+
appKeyAuth: []
43816+
- AuthZ:
43817+
- security_monitoring_filters_write
43818+
summary: Update resource filters
43819+
tags:
43820+
- Security Monitoring
43821+
x-codegen-request-body-name: body
43822+
x-permission:
43823+
operator: OR
43824+
permissions:
43825+
- security_monitoring_filters_write
4362743826
/api/v2/container_images:
4362843827
get:
4362943828
description: Get all Container Images for your organization.

docs/datadog_api_client.v2.model.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6444,6 +6444,20 @@ datadog\_api\_client.v2.model.get\_interfaces\_response module
64446444
:members:
64456445
:show-inheritance:
64466446

6447+
datadog\_api\_client.v2.model.get\_resource\_evaluation\_filters\_response module
6448+
---------------------------------------------------------------------------------
6449+
6450+
.. automodule:: datadog_api_client.v2.model.get_resource_evaluation_filters_response
6451+
:members:
6452+
:show-inheritance:
6453+
6454+
datadog\_api\_client.v2.model.get\_resource\_evaluation\_filters\_response\_data module
6455+
---------------------------------------------------------------------------------------
6456+
6457+
.. automodule:: datadog_api_client.v2.model.get_resource_evaluation_filters_response_data
6458+
:members:
6459+
:show-inheritance:
6460+
64476461
datadog\_api\_client.v2.model.get\_rule\_version\_history\_data module
64486462
----------------------------------------------------------------------
64496463

@@ -12352,6 +12366,20 @@ datadog\_api\_client.v2.model.reorder\_retention\_filters\_request module
1235212366
:members:
1235312367
:show-inheritance:
1235412368

12369+
datadog\_api\_client.v2.model.resource\_filter\_attributes module
12370+
-----------------------------------------------------------------
12371+
12372+
.. automodule:: datadog_api_client.v2.model.resource_filter_attributes
12373+
:members:
12374+
:show-inheritance:
12375+
12376+
datadog\_api\_client.v2.model.resource\_filter\_request\_type module
12377+
--------------------------------------------------------------------
12378+
12379+
.. automodule:: datadog_api_client.v2.model.resource_filter_request_type
12380+
:members:
12381+
:show-inheritance:
12382+
1235512383
datadog\_api\_client.v2.model.response\_meta\_attributes module
1235612384
---------------------------------------------------------------
1235712385

@@ -16825,6 +16853,34 @@ datadog\_api\_client.v2.model.update\_open\_api\_response\_data module
1682516853
:members:
1682616854
:show-inheritance:
1682716855

16856+
datadog\_api\_client.v2.model.update\_resource\_evaluation\_filters\_request module
16857+
-----------------------------------------------------------------------------------
16858+
16859+
.. automodule:: datadog_api_client.v2.model.update_resource_evaluation_filters_request
16860+
:members:
16861+
:show-inheritance:
16862+
16863+
datadog\_api\_client.v2.model.update\_resource\_evaluation\_filters\_request\_data module
16864+
-----------------------------------------------------------------------------------------
16865+
16866+
.. automodule:: datadog_api_client.v2.model.update_resource_evaluation_filters_request_data
16867+
:members:
16868+
:show-inheritance:
16869+
16870+
datadog\_api\_client.v2.model.update\_resource\_evaluation\_filters\_response module
16871+
------------------------------------------------------------------------------------
16872+
16873+
.. automodule:: datadog_api_client.v2.model.update_resource_evaluation_filters_response
16874+
:members:
16875+
:show-inheritance:
16876+
16877+
datadog\_api\_client.v2.model.update\_resource\_evaluation\_filters\_response\_data module
16878+
------------------------------------------------------------------------------------------
16879+
16880+
.. automodule:: datadog_api_client.v2.model.update_resource_evaluation_filters_response_data
16881+
:members:
16882+
:show-inheritance:
16883+
1682816884
datadog\_api\_client.v2.model.update\_rule\_request module
1682916885
----------------------------------------------------------
1683016886

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
List resource filters returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SecurityMonitoringApi(api_client)
11+
response = api_instance.get_resource_evaluation_filters(
12+
cloud_provider="aws",
13+
account_id="123456789",
14+
)
15+
16+
print(response)

0 commit comments

Comments
 (0)