Skip to content

Commit 4ba4dec

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update Security Findings Public API docs (#3070)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent abd97bd commit 4ba4dec

File tree

8 files changed

+6
-52
lines changed

8 files changed

+6
-52
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -82195,13 +82195,6 @@ paths:
8219582195
description: 'Get a list of security findings that match a search query.
8219682196

8219782197

82198-
This endpoint requires one of the following permissions:
82199-
82200-
- `security_monitoring_findings_read`
82201-
82202-
- `appsec_vm_read`
82203-
82204-
8220582198
### Query Syntax
8220682199

8220782200

@@ -82264,8 +82257,6 @@ paths:
8226482257
appKeyAuth: []
8226582258
- AuthZ:
8226682259
- security_monitoring_findings_read
82267-
- AuthZ:
82268-
- appsec_vm_read
8226982260
summary: List security findings
8227082261
tags:
8227182262
- Security Monitoring
@@ -82279,9 +82270,6 @@ paths:
8227982270
permissions:
8228082271
- security_monitoring_findings_read
8228182272
- appsec_vm_read
82282-
x-unstable: '**Note**: This endpoint is in beta and subject to change.
82283-
82284-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8228582273
/api/v2/security/findings/cases:
8228682274
delete:
8228782275
description: 'Detach security findings from their case.
@@ -82506,13 +82494,6 @@ paths:
8250682494
description: 'Get a list of security findings that match a search query.
8250782495

8250882496

82509-
This endpoint requires one of the following permissions:
82510-
82511-
- `security_monitoring_findings_read`
82512-
82513-
- `appsec_vm_read`
82514-
82515-
8251682497
### Query Syntax
8251782498

8251882499

@@ -82546,8 +82527,6 @@ paths:
8254682527
appKeyAuth: []
8254782528
- AuthZ:
8254882529
- security_monitoring_findings_read
82549-
- AuthZ:
82550-
- appsec_vm_read
8255182530
summary: Search security findings
8255282531
tags:
8255382532
- Security Monitoring
@@ -82562,9 +82541,6 @@ paths:
8256282541
permissions:
8256382542
- security_monitoring_findings_read
8256482543
- appsec_vm_read
82565-
x-unstable: '**Note**: This endpoint is in beta and subject to change.
82566-
82567-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8256882544
/api/v2/security/sboms:
8256982545
get:
8257082546
description: 'Get a list of assets SBOMs for an organization.

examples/v2/security-monitoring/ListSecurityFindings.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
77

88
configuration = Configuration()
9-
configuration.unstable_operations["list_security_findings"] = True
109
with ApiClient(configuration) as api_client:
1110
api_instance = SecurityMonitoringApi(api_client)
1211
response = api_instance.list_security_findings()

examples/v2/security-monitoring/ListSecurityFindings_2925663885.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
77

88
configuration = Configuration()
9-
configuration.unstable_operations["list_security_findings"] = True
109
with ApiClient(configuration) as api_client:
1110
api_instance = SecurityMonitoringApi(api_client)
1211
response = api_instance.list_security_findings(

examples/v2/security-monitoring/SearchSecurityFindings.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
)
2020

2121
configuration = Configuration()
22-
configuration.unstable_operations["search_security_findings"] = True
2322
with ApiClient(configuration) as api_client:
2423
api_instance = SecurityMonitoringApi(api_client)
2524
response = api_instance.search_security_findings(body=body)

examples/v2/security-monitoring/SearchSecurityFindings_3678541639.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
)
2424

2525
configuration = Configuration()
26-
configuration.unstable_operations["search_security_findings"] = True
2726
with ApiClient(configuration) as api_client:
2827
api_instance = SecurityMonitoringApi(api_client)
2928
response = api_instance.search_security_findings(body=body)

src/datadog_api_client/configuration.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,14 +282,12 @@ def __init__(
282282
"v2.list_findings": False,
283283
"v2.list_multiple_rulesets": False,
284284
"v2.list_scanned_assets_metadata": False,
285-
"v2.list_security_findings": False,
286285
"v2.list_security_monitoring_histsignals": False,
287286
"v2.list_threat_hunting_jobs": False,
288287
"v2.list_vulnerabilities": False,
289288
"v2.list_vulnerable_assets": False,
290289
"v2.mute_findings": False,
291290
"v2.run_threat_hunting_job": False,
292-
"v2.search_security_findings": False,
293291
"v2.search_security_monitoring_histsignals": False,
294292
"v2.create_dataset": False,
295293
"v2.delete_dataset": False,

src/datadog_api_client/v2/api/security_monitoring_api.py

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3816,11 +3816,6 @@ def list_security_findings(
38163816
38173817
Get a list of security findings that match a search query.
38183818
3819-
This endpoint requires one of the following permissions:
3820-
3821-
* ``security_monitoring_findings_read``
3822-
* ``appsec_vm_read``
3823-
38243819
**Query Syntax**
38253820
38263821
This endpoint uses the logs query syntax. Findings attributes (living in the custom. namespace) are prefixed by @ when queried. Tags are queried without a prefix.
@@ -4724,11 +4719,6 @@ def search_security_findings(
47244719
47254720
Get a list of security findings that match a search query.
47264721
4727-
This endpoint requires one of the following permissions:
4728-
4729-
* ``security_monitoring_findings_read``
4730-
* ``appsec_vm_read``
4731-
47324722
**Query Syntax**
47334723
47344724
The API uses the logs query syntax. Findings attributes (living in the custom. namespace) are prefixed by @ when queried. Tags are queried without a prefix.

tests/v2/features/security_monitoring.feature

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1323,23 +1323,20 @@ Feature: Security Monitoring
13231323

13241324
@team:DataDog/cloud-security-posture-management @team:DataDog/k9-findings-platform
13251325
Scenario: List security findings returns "Bad Request" response
1326-
Given operation "ListSecurityFindings" enabled
1327-
And new "ListSecurityFindings" request
1326+
Given new "ListSecurityFindings" request
13281327
And request contains "page[cursor]" parameter with value "invalid_cursor"
13291328
When the request is sent
13301329
Then the response status is 400 Bad Request
13311330

13321331
@team:DataDog/cloud-security-posture-management @team:DataDog/k9-findings-platform
13331332
Scenario: List security findings returns "OK" response
1334-
Given operation "ListSecurityFindings" enabled
1335-
And new "ListSecurityFindings" request
1333+
Given new "ListSecurityFindings" request
13361334
When the request is sent
13371335
Then the response status is 200 OK
13381336

13391337
@team:DataDog/cloud-security-posture-management @team:DataDog/k9-findings-platform
13401338
Scenario: List security findings returns "OK" response with pagination
1341-
Given operation "ListSecurityFindings" enabled
1342-
And new "ListSecurityFindings" request
1339+
Given new "ListSecurityFindings" request
13431340
And request contains "page[limit]" parameter with value 5
13441341
When the request is sent
13451342
Then the response status is 200 OK
@@ -1602,24 +1599,21 @@ Feature: Security Monitoring
16021599

16031600
@team:DataDog/cloud-security-posture-management @team:DataDog/k9-findings-platform
16041601
Scenario: Search security findings returns "Bad Request" response
1605-
Given operation "SearchSecurityFindings" enabled
1606-
And new "SearchSecurityFindings" request
1602+
Given new "SearchSecurityFindings" request
16071603
And body with value {"page": {"cursor": "invalid_cursor"}}
16081604
When the request is sent
16091605
Then the response status is 400 Bad Request
16101606

16111607
@team:DataDog/cloud-security-posture-management @team:DataDog/k9-findings-platform
16121608
Scenario: Search security findings returns "OK" response
1613-
Given operation "SearchSecurityFindings" enabled
1614-
And new "SearchSecurityFindings" request
1609+
Given new "SearchSecurityFindings" request
16151610
And body with value {"data": {"attributes": {"filter": "@severity:(critical OR high)"}}}
16161611
When the request is sent
16171612
Then the response status is 200 OK
16181613

16191614
@team:DataDog/cloud-security-posture-management @team:DataDog/k9-findings-platform @with-pagination
16201615
Scenario: Search security findings returns "OK" response with pagination
1621-
Given operation "SearchSecurityFindings" enabled
1622-
And new "SearchSecurityFindings" request
1616+
Given new "SearchSecurityFindings" request
16231617
And body with value {"data": {"attributes": {"filter": "@severity:(critical OR high)", "page": {"limit": 1}}}}
16241618
When the request is sent
16251619
Then the response status is 200 OK

0 commit comments

Comments
 (0)