Skip to content

Commit 6160f2f

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

3 files changed

Lines changed: 6 additions & 64 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.

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

services/security_monitoring/src/v2/SecurityMonitoringApi.ts

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3057,16 +3057,6 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
30573057
): Promise<RequestContext> {
30583058
const _config = _options || this.configuration;
30593059

3060-
if (
3061-
!_config.unstableOperations[
3062-
"SecurityMonitoringApi.v2.listSecurityFindings"
3063-
]
3064-
) {
3065-
throw new Error(
3066-
"Unstable operation 'listSecurityFindings' is disabled. Enable it by setting `configuration.unstableOperations['SecurityMonitoringApi.v2.listSecurityFindings'] = true`",
3067-
);
3068-
}
3069-
30703060
// Path Params
30713061
const localVarPath = "/api/v2/security/findings";
30723062

@@ -4349,16 +4339,6 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
43494339
): Promise<RequestContext> {
43504340
const _config = _options || this.configuration;
43514341

4352-
if (
4353-
!_config.unstableOperations[
4354-
"SecurityMonitoringApi.v2.searchSecurityFindings"
4355-
]
4356-
) {
4357-
throw new Error(
4358-
"Unstable operation 'searchSecurityFindings' is disabled. Enable it by setting `configuration.unstableOperations['SecurityMonitoringApi.v2.searchSecurityFindings'] = true`",
4359-
);
4360-
}
4361-
43624342
// verify required parameter 'body' is not null or undefined
43634343
if (body === null || body === undefined) {
43644344
throw new RequiredError("body", "searchSecurityFindings");
@@ -12062,10 +12042,6 @@ export class SecurityMonitoringApi {
1206212042
/**
1206312043
* Get a list of security findings that match a search query.
1206412044
*
12065-
* This endpoint requires one of the following permissions:
12066-
* - `security_monitoring_findings_read`
12067-
* - `appsec_vm_read`
12068-
*
1206912045
* ### Query Syntax
1207012046
*
1207112047
* 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.
@@ -12632,10 +12608,6 @@ export class SecurityMonitoringApi {
1263212608
/**
1263312609
* Get a list of security findings that match a search query.
1263412610
*
12635-
* This endpoint requires one of the following permissions:
12636-
* - `security_monitoring_findings_read`
12637-
* - `appsec_vm_read`
12638-
*
1263912611
* ### Query Syntax
1264012612
*
1264112613
* 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.

0 commit comments

Comments
 (0)