Skip to content

Commit 17f9c86

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update docs for Security Finding API endpoints (#3261)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent e58c7a5 commit 17f9c86

2 files changed

Lines changed: 25 additions & 11 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78107,7 +78107,13 @@ paths:
7810778107
cursorPath: meta.page.cursor
7810878108
limitParam: page[limit]
7810978109
resultsPath: data
78110-
x-unstable: '**Note**: This endpoint is in public beta.
78110+
x-unstable: '**Note**: This endpoint uses the legacy security findings data
78111+
model and is planned for deprecation.
78112+
78113+
Use the [search security findings endpoint](https://docs.datadoghq.com/api/latest/security-monitoring/#search-security-findings),
78114+
78115+
which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/),
78116+
to search security findings.
7811178117

7811278118
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
7811378119
patch:
@@ -78207,7 +78213,13 @@ paths:
7820778213
summary: Get a finding
7820878214
tags:
7820978215
- Security Monitoring
78210-
x-unstable: '**Note**: This endpoint is in public beta.
78216+
x-unstable: '**Note**: This endpoint uses the legacy security findings data
78217+
model and is planned for deprecation.
78218+
78219+
Use the [search security findings endpoint](https://docs.datadoghq.com/api/latest/security-monitoring/#search-security-findings),
78220+
78221+
which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/),
78222+
to search security findings.
7821178223

7821278224
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
7821378225
/api/v2/powerpacks:
@@ -82153,15 +82165,16 @@ paths:
8215382165
- security_monitoring_cws_agent_rules_read
8215482166
/api/v2/security/findings:
8215582167
get:
82156-
description: 'Get a list of security findings that match a search query.
82168+
description: 'Get a list of security findings that match a search query. [See
82169+
the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/).
8215782170

8215882171

8215982172
### Query Syntax
8216082173

8216182174

8216282175
This endpoint uses the logs query syntax. Findings attributes (living in the
82163-
custom. namespace) are prefixed by @ when queried. Tags are queried without
82164-
a prefix.
82176+
attributes.attributes. namespace) are prefixed by @ when queried. Tags are
82177+
queried without a prefix.
8216582178

8216682179

8216782180
Example: `@severity:(critical OR high) @status:open team:platform`'
@@ -82452,13 +82465,14 @@ paths:
8245282465
Please check the documentation regularly for updates.'
8245382466
/api/v2/security/findings/search:
8245482467
post:
82455-
description: 'Get a list of security findings that match a search query.
82468+
description: 'Get a list of security findings that match a search query. [See
82469+
the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/).
8245682470

8245782471

8245882472
### Query Syntax
8245982473

8246082474

82461-
The API uses the logs query syntax. Findings attributes (living in the custom.
82475+
The API uses the logs query syntax. Findings attributes (living in the attributes.attributes.
8246282476
namespace) are prefixed by @ when queried. Tags are queried without a prefix.
8246382477

8246482478

services/security_monitoring/src/v2/SecurityMonitoringApi.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12040,11 +12040,11 @@ export class SecurityMonitoringApi {
1204012040
}
1204112041

1204212042
/**
12043-
* Get a list of security findings that match a search query.
12043+
* Get a list of security findings that match a search query. [See the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/).
1204412044
*
1204512045
* ### Query Syntax
1204612046
*
12047-
* 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.
12047+
* This endpoint uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix.
1204812048
*
1204912049
* Example: `@severity:(critical OR high) @status:open team:platform`
1205012050
* @param param The request object
@@ -12606,11 +12606,11 @@ export class SecurityMonitoringApi {
1260612606
}
1260712607

1260812608
/**
12609-
* Get a list of security findings that match a search query.
12609+
* Get a list of security findings that match a search query. [See the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/).
1261012610
*
1261112611
* ### Query Syntax
1261212612
*
12613-
* 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.
12613+
* The API uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix.
1261412614
*
1261512615
* Example: `@severity:(critical OR high) @status:open team:platform`
1261612616
* @param param The request object

0 commit comments

Comments
 (0)