Skip to content

Commit 261d9a6

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Update Vulnerabilities endpoints documentation (#2428)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 08d831a commit 261d9a6

File tree

7 files changed

+40
-15
lines changed

7 files changed

+40
-15
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-02-27 14:00:43.001632",
8-
"spec_repo_commit": "240ec82d"
7+
"regenerated": "2025-02-27 21:31:40.799230",
8+
"spec_repo_commit": "0b2e3d20"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-27 14:00:43.016339",
13-
"spec_repo_commit": "240ec82d"
12+
"regenerated": "2025-02-27 21:31:40.813872",
13+
"spec_repo_commit": "0b2e3d20"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32353,6 +32353,9 @@ components:
3235332353
apm_service_catalog_read: View service catalog and service definitions.
3235432354
apm_service_catalog_write: Add, modify, and delete service catalog definitions
3235532355
when those definitions are maintained by Datadog.
32356+
appsec_vm_read: View infrastructure, application code, and library vulnerabilities.
32357+
This does not restrict API or inventory SQL access to the vulnerability
32358+
data source.
3235632359
cases_read: View Cases.
3235732360
cases_write: Create and update cases.
3235832361
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
@@ -45204,9 +45207,14 @@ paths:
4520445207
security:
4520545208
- apiKeyAuth: []
4520645209
appKeyAuth: []
45210+
- AuthZ:
45211+
- appsec_vm_read
4520745212
summary: List vulnerable assets
4520845213
tags:
4520945214
- Security Monitoring
45215+
x-unstable: '**Note**: This endpoint is a private preview.
45216+
45217+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
4521045218
/api/v2/security/cloud_workload/policy/download:
4521145219
get:
4521245220
description: 'The download endpoint generates a Cloud Workload Security policy
@@ -45296,12 +45304,14 @@ paths:
4529645304
security:
4529745305
- apiKeyAuth: []
4529845306
appKeyAuth: []
45307+
- AuthZ:
45308+
- appsec_vm_read
4529945309
summary: Get SBOM
4530045310
tags:
4530145311
- Security Monitoring
4530245312
x-unstable: '**Note**: This endpoint is a private preview.
4530345313

45304-
If you are interested in accessing this API, please [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
45314+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
4530545315
/api/v2/security/signals/notification_rules:
4530645316
get:
4530745317
description: Returns the list of notification rules for security signals.
@@ -45857,9 +45867,14 @@ paths:
4585745867
security:
4585845868
- apiKeyAuth: []
4585945869
appKeyAuth: []
45870+
- AuthZ:
45871+
- appsec_vm_read
4586045872
summary: List vulnerabilities
4586145873
tags:
4586245874
- Security Monitoring
45875+
x-unstable: '**Note**: This endpoint is a private preview.
45876+
45877+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
4586345878
/api/v2/security/vulnerabilities/notification_rules:
4586445879
get:
4586545880
description: Returns the list of notification rules for security vulnerabilities.

‎examples/v2/security-monitoring/ListVulnerabilities.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from datadog_api_client.v2.model.vulnerability_tool import VulnerabilityTool
1010

1111
configuration = Configuration()
12+
configuration.unstable_operations["list_vulnerabilities"] = True
1213
with ApiClient(configuration) as api_client:
1314
api_instance = SecurityMonitoringApi(api_client)
1415
response = api_instance.list_vulnerabilities(

‎examples/v2/security-monitoring/ListVulnerableAssets.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
from datadog_api_client.v2.model.asset_type import AssetType
88

99
configuration = Configuration()
10+
configuration.unstable_operations["list_vulnerable_assets"] = True
1011
with ApiClient(configuration) as api_client:
1112
api_instance = SecurityMonitoringApi(api_client)
1213
response = api_instance.list_vulnerable_assets(

‎src/datadog_api_client/configuration.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,8 @@ def __init__(
294294
"v2.get_sbom": False,
295295
"v2.list_findings": False,
296296
"v2.list_historical_jobs": False,
297+
"v2.list_vulnerabilities": False,
298+
"v2.list_vulnerable_assets": False,
297299
"v2.mute_findings": False,
298300
"v2.run_historical_job": False,
299301
"v2.create_scorecard_outcomes_batch": False,

‎src/datadog_api_client/v2/api/security_monitoring_api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ def __init__(self, api_client=None):
593593
self._get_sbom_endpoint = _Endpoint(
594594
settings={
595595
"response_type": (GetSBOMResponse,),
596-
"auth": ["apiKeyAuth", "appKeyAuth"],
596+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
597597
"endpoint_path": "/api/v2/security/sboms/{asset_type}",
598598
"operation_id": "get_sbom",
599599
"http_method": "GET",
@@ -1033,7 +1033,7 @@ def __init__(self, api_client=None):
10331033
self._list_vulnerabilities_endpoint = _Endpoint(
10341034
settings={
10351035
"response_type": (ListVulnerabilitiesResponse,),
1036-
"auth": ["apiKeyAuth", "appKeyAuth"],
1036+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
10371037
"endpoint_path": "/api/v2/security/vulnerabilities",
10381038
"operation_id": "list_vulnerabilities",
10391039
"http_method": "GET",
@@ -1265,7 +1265,7 @@ def __init__(self, api_client=None):
12651265
self._list_vulnerable_assets_endpoint = _Endpoint(
12661266
settings={
12671267
"response_type": (ListVulnerableAssetsResponse,),
1268-
"auth": ["apiKeyAuth", "appKeyAuth"],
1268+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
12691269
"endpoint_path": "/api/v2/security/assets",
12701270
"operation_id": "list_vulnerable_assets",
12711271
"http_method": "GET",

‎tests/v2/features/security_monitoring.feature

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ Feature: Security Monitoring
473473
When the request is sent
474474
Then the response status is 404 Not found: asset not found
475475

476-
@team:DataDog/asm-vm
476+
@skip @team:DataDog/asm-vm
477477
Scenario: Get SBOM returns "OK" response
478478
Given operation "GetSBOM" enabled
479479
And new "GetSBOM" request
@@ -830,21 +830,24 @@ Feature: Security Monitoring
830830

831831
@generated @skip @team:DataDog/asm-vm
832832
Scenario: List vulnerabilities returns "Bad request: The server cannot process the request due to invalid syntax in the request." response
833-
Given new "ListVulnerabilities" request
833+
Given operation "ListVulnerabilities" enabled
834+
And new "ListVulnerabilities" request
834835
When the request is sent
835836
Then the response status is 400 Bad request: The server cannot process the request due to invalid syntax in the request.
836837

837838
@team:DataDog/asm-vm
838839
Scenario: List vulnerabilities returns "Not found: There is no request associated with the provided token." response
839-
Given new "ListVulnerabilities" request
840+
Given operation "ListVulnerabilities" enabled
841+
And new "ListVulnerabilities" request
840842
And request contains "page[token]" parameter with value "unknown"
841843
And request contains "page[number]" parameter with value 1
842844
When the request is sent
843845
Then the response status is 404 Not found: There is no request associated with the provided token.
844846

845847
@team:DataDog/asm-vm
846848
Scenario: List vulnerabilities returns "OK" response
847-
Given new "ListVulnerabilities" request
849+
Given operation "ListVulnerabilities" enabled
850+
And new "ListVulnerabilities" request
848851
And request contains "filter[cvss.base.severity]" parameter with value "High"
849852
And request contains "filter[asset.type]" parameter with value "Service"
850853
And request contains "filter[tool]" parameter with value "Infra"
@@ -853,21 +856,24 @@ Feature: Security Monitoring
853856

854857
@generated @skip @team:DataDog/asm-vm
855858
Scenario: List vulnerable assets returns "Bad request: The server cannot process the request due to invalid syntax in the request." response
856-
Given new "ListVulnerableAssets" request
859+
Given operation "ListVulnerableAssets" enabled
860+
And new "ListVulnerableAssets" request
857861
When the request is sent
858862
Then the response status is 400 Bad request: The server cannot process the request due to invalid syntax in the request.
859863

860864
@team:DataDog/asm-vm
861865
Scenario: List vulnerable assets returns "Not found: There is no request associated with the provided token." response
862-
Given new "ListVulnerableAssets" request
866+
Given operation "ListVulnerableAssets" enabled
867+
And new "ListVulnerableAssets" request
863868
And request contains "page[token]" parameter with value "unknown"
864869
And request contains "page[number]" parameter with value 1
865870
When the request is sent
866871
Then the response status is 404 Not found: There is no request associated with the provided token.
867872

868873
@team:DataDog/asm-vm
869874
Scenario: List vulnerable assets returns "OK" response
870-
Given new "ListVulnerableAssets" request
875+
Given operation "ListVulnerableAssets" enabled
876+
And new "ListVulnerableAssets" request
871877
And request contains "filter[type]" parameter with value "Host"
872878
And request contains "filter[repository_url]" parameter with value "github.com/datadog/dd-go"
873879
And request contains "filter[risks.in_production]" parameter with value true

0 commit comments

Comments
 (0)