Skip to content

Commit c750dad

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

8 files changed

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

examples/v2/security-monitoring/ListSecurityFindings.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
import { client, v2 } from "@datadog/datadog-api-client";
66

77
const configuration = client.createConfiguration();
8-
configuration.unstableOperations["v2.listSecurityFindings"] = true;
98
const apiInstance = new v2.SecurityMonitoringApi(configuration);
109

1110
apiInstance

examples/v2/security-monitoring/ListSecurityFindings_2925663885.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
import { client, v2 } from "@datadog/datadog-api-client";
66

77
const configuration = client.createConfiguration();
8-
configuration.unstableOperations["v2.listSecurityFindings"] = true;
98
const apiInstance = new v2.SecurityMonitoringApi(configuration);
109

1110
const params: v2.SecurityMonitoringApiListSecurityFindingsRequest = {

examples/v2/security-monitoring/SearchSecurityFindings.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
import { client, v2 } from "@datadog/datadog-api-client";
66

77
const configuration = client.createConfiguration();
8-
configuration.unstableOperations["v2.searchSecurityFindings"] = true;
98
const apiInstance = new v2.SecurityMonitoringApi(configuration);
109

1110
const params: v2.SecurityMonitoringApiSearchSecurityFindingsRequest = {

examples/v2/security-monitoring/SearchSecurityFindings_3678541639.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
import { client, v2 } from "@datadog/datadog-api-client";
66

77
const configuration = client.createConfiguration();
8-
configuration.unstableOperations["v2.searchSecurityFindings"] = true;
98
const apiInstance = new v2.SecurityMonitoringApi(configuration);
109

1110
const params: v2.SecurityMonitoringApiSearchSecurityFindingsRequest = {

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

packages/datadog-api-client-common/configuration.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,14 +257,12 @@ export function createConfiguration(
257257
"v2.listFindings": false,
258258
"v2.listMultipleRulesets": false,
259259
"v2.listScannedAssetsMetadata": false,
260-
"v2.listSecurityFindings": false,
261260
"v2.listSecurityMonitoringHistsignals": false,
262261
"v2.listThreatHuntingJobs": false,
263262
"v2.listVulnerabilities": false,
264263
"v2.listVulnerableAssets": false,
265264
"v2.muteFindings": false,
266265
"v2.runThreatHuntingJob": false,
267-
"v2.searchSecurityFindings": false,
268266
"v2.searchSecurityMonitoringHistsignals": false,
269267
"v2.createDataset": false,
270268
"v2.deleteDataset": false,

packages/datadog-api-client-v2/apis/SecurityMonitoringApi.ts

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2500,11 +2500,6 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
25002500
): Promise<RequestContext> {
25012501
const _config = _options || this.configuration;
25022502

2503-
logger.warn("Using unstable operation 'listSecurityFindings'");
2504-
if (!_config.unstableOperations["v2.listSecurityFindings"]) {
2505-
throw new Error("Unstable operation 'listSecurityFindings' is disabled");
2506-
}
2507-
25082503
// Path Params
25092504
const localVarPath = "/api/v2/security/findings";
25102505

@@ -3659,13 +3654,6 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
36593654
): Promise<RequestContext> {
36603655
const _config = _options || this.configuration;
36613656

3662-
logger.warn("Using unstable operation 'searchSecurityFindings'");
3663-
if (!_config.unstableOperations["v2.searchSecurityFindings"]) {
3664-
throw new Error(
3665-
"Unstable operation 'searchSecurityFindings' is disabled"
3666-
);
3667-
}
3668-
36693657
// verify required parameter 'body' is not null or undefined
36703658
if (body === null || body === undefined) {
36713659
throw new RequiredError("body", "searchSecurityFindings");
@@ -11511,10 +11499,6 @@ export class SecurityMonitoringApi {
1151111499
/**
1151211500
* Get a list of security findings that match a search query.
1151311501
*
11514-
* This endpoint requires one of the following permissions:
11515-
* - `security_monitoring_findings_read`
11516-
* - `appsec_vm_read`
11517-
*
1151811502
* ### Query Syntax
1151911503
*
1152011504
* 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.
@@ -12084,10 +12068,6 @@ export class SecurityMonitoringApi {
1208412068
/**
1208512069
* Get a list of security findings that match a search query.
1208612070
*
12087-
* This endpoint requires one of the following permissions:
12088-
* - `security_monitoring_findings_read`
12089-
* - `appsec_vm_read`
12090-
*
1209112071
* ### Query Syntax
1209212072
*
1209312073
* 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)