Skip to content

Commit eb52549

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ee0f38d of spec repo
1 parent 07c5c19 commit eb52549

19 files changed

+1404
-39
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 257 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9186,6 +9186,18 @@ components:
91869186
required:
91879187
- type
91889188
type: object
9189+
CloudAssetType:
9190+
description: The cloud asset type
9191+
enum:
9192+
- Host
9193+
- HostImage
9194+
- Image
9195+
example: Host
9196+
type: string
9197+
x-enum-varnames:
9198+
- HOST
9199+
- HOST_IMAGE
9200+
- IMAGE
91899201
CloudConfigurationComplianceRuleOptions:
91909202
additionalProperties: {}
91919203
description: 'Options for cloud_configuration rules.
@@ -26664,6 +26676,21 @@ components:
2666426676
example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
2666526677
type: string
2666626678
type: object
26679+
ListScannedAssetsMetadata:
26680+
description: The expected response schema when listing scanned assets metadata.
26681+
properties:
26682+
data:
26683+
description: List of scanned assets metadata.
26684+
items:
26685+
$ref: '#/components/schemas/ScannedAssetMetadata'
26686+
type: array
26687+
links:
26688+
$ref: '#/components/schemas/Links'
26689+
meta:
26690+
$ref: '#/components/schemas/Metadata'
26691+
required:
26692+
- data
26693+
type: object
2666726694
ListTagsResponse:
2666826695
description: List tags response.
2666926696
properties:
@@ -40967,6 +40994,16 @@ components:
4096740994
- MACHINE_LEARNING_MODEL
4096840995
- OPERATING_SYSTEM
4096940996
- PLATFORM
40997+
SBOMFormat:
40998+
description: The SBOM standard
40999+
enum:
41000+
- CycloneDX
41001+
- SPDX
41002+
example: CycloneDX
41003+
type: string
41004+
x-enum-varnames:
41005+
- CYCLONEDX
41006+
- SPDX
4097041007
SBOMMetadata:
4097141008
description: Provides additional information about a BOM.
4097241009
properties:
@@ -41232,6 +41269,71 @@ components:
4123241269
type:
4123341270
$ref: '#/components/schemas/ScalarFormulaResponseType'
4123441271
type: object
41272+
ScannedAssetMetadata:
41273+
description: The metadata of a scanned asset.
41274+
properties:
41275+
attributes:
41276+
$ref: '#/components/schemas/ScannedAssetMetadataAttributes'
41277+
id:
41278+
description: The ID of the scanned asset metadata.
41279+
example: Host|i-0fc7edef1ab26d7ef
41280+
type: string
41281+
required:
41282+
- id
41283+
- attributes
41284+
type: object
41285+
ScannedAssetMetadataAsset:
41286+
description: The asset of a scanned asset metadata.
41287+
properties:
41288+
name:
41289+
description: The name of the asset.
41290+
example: i-0fc7edef1ab26d7ef
41291+
type: string
41292+
type:
41293+
$ref: '#/components/schemas/CloudAssetType'
41294+
required:
41295+
- type
41296+
- name
41297+
type: object
41298+
ScannedAssetMetadataAttributes:
41299+
description: The attributes of a scanned asset metadata.
41300+
properties:
41301+
asset:
41302+
$ref: '#/components/schemas/ScannedAssetMetadataAsset'
41303+
first_success_timestamp:
41304+
description: The timestamp when the scan of the asset was performed for
41305+
the first time.
41306+
example: '2025-07-08T07:24:53Z'
41307+
type: string
41308+
last_success:
41309+
$ref: '#/components/schemas/ScannedAssetMetadataLastSuccess'
41310+
required:
41311+
- asset
41312+
- last_success
41313+
- first_success_timestamp
41314+
type: object
41315+
ScannedAssetMetadataLastSuccess:
41316+
description: The last success scan that has been performed to an asset.
41317+
properties:
41318+
env:
41319+
description: The environment of the last success scan of the asset.
41320+
example: prod
41321+
type: string
41322+
origin:
41323+
description: The list of origins of the last success scan of the asset.
41324+
example:
41325+
- production
41326+
items:
41327+
example: production
41328+
type: string
41329+
type: array
41330+
timestamp:
41331+
description: The timestamp of the last success scan of the asset.
41332+
example: '2025-07-08T07:24:53Z'
41333+
type: string
41334+
required:
41335+
- timestamp
41336+
type: object
4123541337
Schedule:
4123641338
description: Top-level container for a schedule object, including both the `data`
4123741339
payload and any related `included` resources (such as teams, layers, or members).
@@ -51419,13 +51521,29 @@ components:
5141951521
- attributes
5142051522
- relationships
5142151523
type: object
51422-
VulnerabilityAttributes:
51423-
description: The JSON:API attributes of the vulnerability.
51524+
VulnerabilityAdvisory:
51525+
description: Advisory that associated with the vulnerability.
5142451526
properties:
51425-
advisory_id:
51527+
id:
5142651528
description: Vulnerability advisory ID.
5142751529
example: TRIVY-CVE-2023-0615
5142851530
type: string
51531+
last_modification_date:
51532+
description: Vulnerability advisory last modification date.
51533+
example: 2024-09-19 21:23:08+00:00
51534+
type: string
51535+
publish_date:
51536+
description: Vulnerability advisory publish date.
51537+
example: 2024-09-19 21:23:08+00:00
51538+
type: string
51539+
required:
51540+
- id
51541+
type: object
51542+
VulnerabilityAttributes:
51543+
description: The JSON:API attributes of the vulnerability.
51544+
properties:
51545+
advisory:
51546+
$ref: '#/components/schemas/VulnerabilityAdvisory'
5142951547
code_location:
5143051548
$ref: '#/components/schemas/CodeLocation'
5143151549
cve_list:
@@ -70913,7 +71031,7 @@ paths:
7091371031
format: int64
7091471032
minimum: 1
7091571033
type: integer
70916-
- description: Filter by name.
71034+
- description: Filter by name. This field supports the usage of wildcards (*).
7091771035
example: datadog-agent
7091871036
in: query
7091971037
name: filter[name]
@@ -71208,7 +71326,7 @@ paths:
7120871326
security:
7120971327
- apiKeyAuth: []
7121071328
appKeyAuth: []
71211-
summary: List assets SBOMs
71329+
summary: List SBOMs
7121271330
tags:
7121371331
- Security Monitoring
7121471332
x-unstable: '**Note**: This endpoint is a private preview.
@@ -71241,6 +71359,13 @@ paths:
7124171359
required: false
7124271360
schema:
7124371361
type: string
71362+
- description: The standard of the SBOM.
71363+
example: CycloneDX
71364+
in: query
71365+
name: ext:format
71366+
required: false
71367+
schema:
71368+
$ref: '#/components/schemas/SBOMFormat'
7124471369
responses:
7124571370
'200':
7124671371
content:
@@ -71278,6 +71403,115 @@ paths:
7127871403
x-unstable: '**Note**: This endpoint is a private preview.
7127971404

7128071405
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
71406+
/api/v2/security/scanned-assets-metadata:
71407+
get:
71408+
description: 'Get a list of security scanned assets metadata for an organization.
71409+
71410+
71411+
### Pagination
71412+
71413+
71414+
Please review the [Pagination section](#pagination) for the "List Vulnerabilities"
71415+
endpoint.
71416+
71417+
71418+
### Filtering
71419+
71420+
71421+
Please review the [Filtering section](#filtering) for the "List Vulnerabilities"
71422+
endpoint.
71423+
71424+
71425+
### Metadata
71426+
71427+
71428+
Please review the [Metadata section](#metadata) for the "List Vulnerabilities"
71429+
endpoint.'
71430+
operationId: ListScannedAssetsMetadata
71431+
parameters:
71432+
- description: Its value must come from the `links` section of the response
71433+
of the first request. Do not manually edit it.
71434+
example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4
71435+
in: query
71436+
name: page[token]
71437+
required: false
71438+
schema:
71439+
type: string
71440+
- description: The page number to be retrieved. It should be equal to or greater
71441+
than 1.
71442+
example: 1
71443+
in: query
71444+
name: page[number]
71445+
required: false
71446+
schema:
71447+
format: int64
71448+
minimum: 1
71449+
type: integer
71450+
- description: The type of the scanned asset.
71451+
example: Host
71452+
in: query
71453+
name: filter[asset.type]
71454+
required: false
71455+
schema:
71456+
$ref: '#/components/schemas/CloudAssetType'
71457+
- description: The name of the scanned asset.
71458+
example: i-0fc7edef1ab26d7ef
71459+
in: query
71460+
name: filter[asset.name]
71461+
required: false
71462+
schema:
71463+
type: string
71464+
- description: The origin of last success scan.
71465+
example: agent
71466+
in: query
71467+
name: filter[last_success.origin]
71468+
required: false
71469+
schema:
71470+
type: string
71471+
- description: The environment of last success scan.
71472+
example: prod
71473+
in: query
71474+
name: filter[last_success.env]
71475+
required: false
71476+
schema:
71477+
type: string
71478+
responses:
71479+
'200':
71480+
content:
71481+
application/json:
71482+
schema:
71483+
$ref: '#/components/schemas/ListScannedAssetsMetadata'
71484+
description: OK
71485+
'400':
71486+
content:
71487+
application/json:
71488+
schema:
71489+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71490+
description: 'Bad request: The server cannot process the request due to
71491+
invalid syntax in the request.'
71492+
'403':
71493+
content:
71494+
application/json:
71495+
schema:
71496+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71497+
description: 'Forbidden: Access denied'
71498+
'404':
71499+
content:
71500+
application/json:
71501+
schema:
71502+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71503+
description: 'Not found: asset not found'
71504+
'429':
71505+
$ref: '#/components/responses/TooManyRequestsResponse'
71506+
security:
71507+
- apiKeyAuth: []
71508+
appKeyAuth: []
71509+
summary: List Scanned Assets Metadata
71510+
tags:
71511+
- Security Monitoring
71512+
x-unstable: '**Note**: This endpoint is a private preview.
71513+
71514+
If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
7128171515
/api/v2/security/signals/notification_rules:
7128271516
get:
7128371517
description: Returns the list of notification rules for security signals.
@@ -71468,12 +71702,16 @@ paths:
7146871702
consider a request to be the first request when there is no `page[token]`
7146971703
parameter.\n\nThe response of this first request contains the newly created
7147071704
token in the `links` section.\n\nThis token can then be used in the subsequent
71471-
paginated requests.\n\n#### Subsequent requests\n\nAny request containing
71705+
paginated requests.\n\n*Note: The first request may take longer to complete
71706+
than subsequent requests.*\n\n#### Subsequent requests\n\nAny request containing
7147271707
valid `page[token]` and `page[number]` parameters will be considered a subsequent
7147371708
request.\n\nIf the `token` is invalid, a `404` response will be returned.\n\nIf
71474-
the page `number` is invalid, a `400` response will be returned.\n\n### Filtering\n\nThe
71475-
request can include some filter parameters to filter the data to be retrieved.
71476-
The format of the filter parameters follows the [JSON:API format](https://jsonapi.org/format/#fetching-filtering):
71709+
the page `number` is invalid, a `400` response will be returned.\n\nThe returned
71710+
`token` remains valid for every request in the pagination sequence. You may
71711+
send paginated requests in parallel by re-using this `token` and varying only
71712+
the `page[number]` parameter.\n\n### Filtering\n\nThe request can include
71713+
some filter parameters to filter the data to be retrieved. The format of the
71714+
filter parameters follows the [JSON:API format](https://jsonapi.org/format/#fetching-filtering):
7147771715
`filter[$prop_name]`, where `prop_name` is the property name in the entity
7147871716
being filtered by.\n\nAll filters can include multiple values, where data
7147971717
will be filtered with an OR clause: `filter[title]=Title1,Title2` will filter
@@ -71488,7 +71726,12 @@ paths:
7148871726
For more details on each of the properties included in this section, check
7148971727
the endpoints response tables.\n\n```JSON\n{\n \"data\": [...],\n \"meta\":
7149071728
{\n \"total\": 1500,\n \"count\": 18732,\n \"token\": \"some_token\"\n
71491-
\ },\n \"links\": {...}\n}\n```"
71729+
\ },\n \"links\": {...}\n}\n```\n### Extensions\n\nThe request in some cases
71730+
can include extensions to update behavior of the endpoint requested. The format
71731+
of the filter parameters follows the [JSON:API format](https://jsonapi.org/extensions/#extensions):
71732+
`ext:$extension_name`, where `extension_name` is the name of the modifier
71733+
that is being applied.\n\nExtensions can only include one value at the moment:
71734+
`ext:modifier=value`."
7149271735
operationId: ListVulnerabilities
7149371736
parameters:
7149471737
- description: Its value must come from the `links` section of the response
@@ -71594,9 +71837,9 @@ paths:
7159471837
schema:
7159571838
type: string
7159671839
- description: Filter by advisory ID.
71597-
example: TRIVY-CVE-2023-0615
71840+
example: CVE-2023-0615
7159871841
in: query
71599-
name: filter[advisory_id]
71842+
name: filter[advisory.id]
7160071843
required: false
7160171844
schema:
7160271845
type: string
@@ -71696,7 +71939,8 @@ paths:
7169671939
required: false
7169771940
schema:
7169871941
type: string
71699-
- description: Filter by asset name.
71942+
- description: Filter by asset name. This field supports the usage of wildcards
71943+
(*).
7170071944
example: datadog-agent
7170171945
in: query
7170271946
name: filter[asset.name]
Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
# List assets SBOMs returns "OK" response
1+
# List SBOMs returns "OK" response
22

33
require "datadog_api_client"
44
DatadogAPIClient.configure do |config|
55
config.unstable_operations["v2.list_assets_sbo_ms".to_sym] = true
66
end
77
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
8-
opts = {
9-
filter_package_name: "pandas",
10-
filter_asset_type: AssetType::SERVICE,
11-
}
12-
p api_instance.list_assets_sbo_ms(opts)
8+
p api_instance.list_assets_sbo_ms()
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# List assets SBOMs returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.list_assets_sbo_ms".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
8+
opts = {
9+
filter_package_name: "pandas",
10+
filter_asset_type: AssetType::SERVICE,
11+
}
12+
p api_instance.list_assets_sbo_ms(opts)

0 commit comments

Comments
 (0)