Skip to content

Commit 5838037

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

8 files changed

Lines changed: 6 additions & 68 deletions

File tree

‎.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.

‎api/datadog/configuration.go‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -688,14 +688,12 @@ func NewConfiguration() *Configuration {
688688
"v2.ListFindings": false,
689689
"v2.ListMultipleRulesets": false,
690690
"v2.ListScannedAssetsMetadata": false,
691-
"v2.ListSecurityFindings": false,
692691
"v2.ListSecurityMonitoringHistsignals": false,
693692
"v2.ListThreatHuntingJobs": false,
694693
"v2.ListVulnerabilities": false,
695694
"v2.ListVulnerableAssets": false,
696695
"v2.MuteFindings": false,
697696
"v2.RunThreatHuntingJob": false,
698-
"v2.SearchSecurityFindings": false,
699697
"v2.SearchSecurityMonitoringHistsignals": false,
700698
"v2.CreateDataset": false,
701699
"v2.DeleteDataset": false,

‎api/datadogV2/api_security_monitoring.go‎

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4875,10 +4875,6 @@ func (r *ListSecurityFindingsOptionalParameters) WithSort(sort SecurityFindingsS
48754875
// ListSecurityFindings List security findings.
48764876
// Get a list of security findings that match a search query.
48774877
//
4878-
// This endpoint requires one of the following permissions:
4879-
// - `security_monitoring_findings_read`
4880-
// - `appsec_vm_read`
4881-
//
48824878
// ### Query Syntax
48834879
//
48844880
// 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.
@@ -4899,15 +4895,6 @@ func (a *SecurityMonitoringApi) ListSecurityFindings(ctx _context.Context, o ...
48994895
optionalParams = o[0]
49004896
}
49014897

4902-
operationId := "v2.ListSecurityFindings"
4903-
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
4904-
if !isOperationEnabled {
4905-
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
4906-
}
4907-
if isOperationEnabled && a.Client.Cfg.Debug {
4908-
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
4909-
}
4910-
49114898
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.SecurityMonitoringApi.ListSecurityFindings")
49124899
if err != nil {
49134900
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
@@ -7079,10 +7066,6 @@ func (a *SecurityMonitoringApi) RunThreatHuntingJob(ctx _context.Context, body R
70797066
// SearchSecurityFindings Search security findings.
70807067
// Get a list of security findings that match a search query.
70817068
//
7082-
// This endpoint requires one of the following permissions:
7083-
// - `security_monitoring_findings_read`
7084-
// - `appsec_vm_read`
7085-
//
70867069
// ### Query Syntax
70877070
//
70887071
// 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.
@@ -7095,15 +7078,6 @@ func (a *SecurityMonitoringApi) SearchSecurityFindings(ctx _context.Context, bod
70957078
localVarReturnValue ListSecurityFindingsResponse
70967079
)
70977080

7098-
operationId := "v2.SearchSecurityFindings"
7099-
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
7100-
if !isOperationEnabled {
7101-
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
7102-
}
7103-
if isOperationEnabled && a.Client.Cfg.Debug {
7104-
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
7105-
}
7106-
71077081
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.SecurityMonitoringApi.SearchSecurityFindings")
71087082
if err != nil {
71097083
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}

‎examples/v2/security-monitoring/ListSecurityFindings.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import (
1515
func main() {
1616
ctx := datadog.NewDefaultContext(context.Background())
1717
configuration := datadog.NewConfiguration()
18-
configuration.SetUnstableOperationEnabled("v2.ListSecurityFindings", true)
1918
apiClient := datadog.NewAPIClient(configuration)
2019
api := datadogV2.NewSecurityMonitoringApi(apiClient)
2120
resp, r, err := api.ListSecurityFindings(ctx, *datadogV2.NewListSecurityFindingsOptionalParameters())

‎examples/v2/security-monitoring/ListSecurityFindings_2925663885.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import (
1515
func main() {
1616
ctx := datadog.NewDefaultContext(context.Background())
1717
configuration := datadog.NewConfiguration()
18-
configuration.SetUnstableOperationEnabled("v2.ListSecurityFindings", true)
1918
apiClient := datadog.NewAPIClient(configuration)
2019
api := datadogV2.NewSecurityMonitoringApi(apiClient)
2120
resp, r, err := api.ListSecurityFindings(ctx, *datadogV2.NewListSecurityFindingsOptionalParameters().WithPageLimit(5))

‎examples/v2/security-monitoring/SearchSecurityFindings.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ func main() {
2222
}
2323
ctx := datadog.NewDefaultContext(context.Background())
2424
configuration := datadog.NewConfiguration()
25-
configuration.SetUnstableOperationEnabled("v2.SearchSecurityFindings", true)
2625
apiClient := datadog.NewAPIClient(configuration)
2726
api := datadogV2.NewSecurityMonitoringApi(apiClient)
2827
resp, r, err := api.SearchSecurityFindings(ctx, body)

‎examples/v2/security-monitoring/SearchSecurityFindings_3678541639.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ func main() {
2525
}
2626
ctx := datadog.NewDefaultContext(context.Background())
2727
configuration := datadog.NewConfiguration()
28-
configuration.SetUnstableOperationEnabled("v2.SearchSecurityFindings", true)
2928
apiClient := datadog.NewAPIClient(configuration)
3029
api := datadogV2.NewSecurityMonitoringApi(apiClient)
3130
resp, r, err := api.SearchSecurityFindings(ctx, body)

‎tests/scenarios/features/v2/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)