Skip to content

Commit 8a071aa

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 550b563 of spec repo
1 parent fd58c5a commit 8a071aa

18 files changed

Lines changed: 1064 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 338 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,6 +1314,67 @@ components:
13141314
required: true
13151315
schema:
13161316
type: string
1317+
RuleBasedViewFramework:
1318+
description: Compliance framework handle to filter rules and findings by.
1319+
in: query
1320+
name: framework
1321+
required: false
1322+
schema:
1323+
default: ""
1324+
example: hipaa
1325+
type: string
1326+
RuleBasedViewIncludeRulesWithoutFindings:
1327+
description: When `true`, includes rules in the response that have no associated findings.
1328+
in: query
1329+
name: include_rules_without_findings
1330+
required: false
1331+
schema:
1332+
default: false
1333+
example: false
1334+
type: boolean
1335+
RuleBasedViewIsCustom:
1336+
description: Set to `true` when the requested `framework` is a custom framework.
1337+
in: query
1338+
name: is_custom
1339+
required: false
1340+
schema:
1341+
example: false
1342+
type: boolean
1343+
RuleBasedViewQuery:
1344+
description: Additional event-platform filters applied to the underlying findings query. For example, `scored:true project_id:datadog-prod-us5`.
1345+
in: query
1346+
name: query
1347+
required: false
1348+
schema:
1349+
default: ""
1350+
example: scored:true
1351+
type: string
1352+
RuleBasedViewQueryFindingsWithoutFrameworkVersion:
1353+
description: When `true`, returns findings without a `framework_version` tag. Used for findings from custom frameworks or those created before framework versioning was introduced.
1354+
in: query
1355+
name: query_findings_without_framework_version
1356+
required: false
1357+
schema:
1358+
default: false
1359+
example: false
1360+
type: boolean
1361+
RuleBasedViewTo:
1362+
description: Timestamp of the query end, in milliseconds since the Unix epoch.
1363+
in: query
1364+
name: to
1365+
required: true
1366+
schema:
1367+
example: 1739982278000
1368+
format: int64
1369+
type: integer
1370+
RuleBasedViewVersion:
1371+
description: Version of the compliance framework to filter rules and findings by.
1372+
in: query
1373+
name: version
1374+
required: false
1375+
schema:
1376+
example: "1"
1377+
type: string
13171378
RuleId:
13181379
description: The ID of the rule.
13191380
in: path
@@ -60636,6 +60697,194 @@ components:
6063660697
example: Deployments automated via Deployment Trains
6063760698
type: string
6063860699
type: object
60700+
RuleBasedViewAttributes:
60701+
description: Attributes of the rule-based view.
60702+
properties:
60703+
count:
60704+
description: Total number of rules in the view.
60705+
example: 1
60706+
format: int64
60707+
type: integer
60708+
rules:
60709+
$ref: "#/components/schemas/RuleBasedViewRules"
60710+
required:
60711+
- count
60712+
- rules
60713+
type: object
60714+
RuleBasedViewComplianceFramework:
60715+
description: Compliance framework mapping for a rule.
60716+
properties:
60717+
control:
60718+
description: Identifier of the control inside the requirement.
60719+
example: 164.308-a-4-i
60720+
type: string
60721+
framework:
60722+
description: Handle of the compliance framework.
60723+
example: hipaa
60724+
type: string
60725+
is_default:
60726+
description: Whether the framework is a Datadog default framework. `true` indicates a Datadog framework and `false` indicates a custom framework.
60727+
example: true
60728+
type: boolean
60729+
message:
60730+
description: Optional message describing the framework mapping for the rule.
60731+
example: ""
60732+
type: string
60733+
requirement:
60734+
description: Name of the requirement that contains the control.
60735+
example: Information-Access-Management
60736+
type: string
60737+
version:
60738+
description: Version of the compliance framework.
60739+
example: "1"
60740+
type: string
60741+
type: object
60742+
RuleBasedViewComplianceFrameworks:
60743+
description: List of compliance framework mappings associated with the rule.
60744+
items:
60745+
$ref: "#/components/schemas/RuleBasedViewComplianceFramework"
60746+
type: array
60747+
RuleBasedViewData:
60748+
description: Data envelope for the rule-based view response.
60749+
properties:
60750+
attributes:
60751+
$ref: "#/components/schemas/RuleBasedViewAttributes"
60752+
id:
60753+
description: Unique identifier of the rule-based view document.
60754+
example: JSONAPI_USELESS_ID
60755+
type: string
60756+
type:
60757+
$ref: "#/components/schemas/RuleBasedViewType"
60758+
required:
60759+
- attributes
60760+
- id
60761+
- type
60762+
type: object
60763+
RuleBasedViewResourceAttributes:
60764+
description: List of resource attribute names exposed by the rule.
60765+
example:
60766+
- instance_id
60767+
items:
60768+
description: Name of a resource attribute exposed by the rule.
60769+
example: instance_id
60770+
type: string
60771+
type: array
60772+
RuleBasedViewResponse:
60773+
description: Response containing an aggregated view of compliance rules with their finding statistics.
60774+
properties:
60775+
data:
60776+
$ref: "#/components/schemas/RuleBasedViewData"
60777+
required:
60778+
- data
60779+
type: object
60780+
RuleBasedViewRule:
60781+
description: A compliance rule along with its evaluation statistics and framework mappings.
60782+
properties:
60783+
compliance_frameworks:
60784+
$ref: "#/components/schemas/RuleBasedViewComplianceFrameworks"
60785+
enabled:
60786+
description: Whether the rule is enabled.
60787+
example: true
60788+
type: boolean
60789+
id:
60790+
description: Unique identifier of the rule.
60791+
example: qjx-udx-xo8
60792+
type: string
60793+
name:
60794+
description: Human-readable name of the rule.
60795+
example: IAM roles should not allow untrusted GitHub Actions to assume them
60796+
type: string
60797+
resourceAttributes:
60798+
$ref: "#/components/schemas/RuleBasedViewResourceAttributes"
60799+
resourceCategory:
60800+
description: Resource category targeted by the rule.
60801+
example: identity
60802+
type: string
60803+
resourceType:
60804+
description: Resource type targeted by the rule.
60805+
example: aws_iam_role
60806+
type: string
60807+
stats:
60808+
$ref: "#/components/schemas/RuleBasedViewRuleStats"
60809+
status:
60810+
description: Severity associated with the rule (for example, `info`, `low`, `medium`, `high`, or `critical`).
60811+
example: critical
60812+
type: string
60813+
tags:
60814+
$ref: "#/components/schemas/RuleBasedViewRuleTags"
60815+
type:
60816+
$ref: "#/components/schemas/RuleBasedViewRuleCategory"
60817+
required:
60818+
- compliance_frameworks
60819+
- enabled
60820+
- id
60821+
- name
60822+
- resourceAttributes
60823+
- resourceCategory
60824+
- resourceType
60825+
- stats
60826+
- status
60827+
- tags
60828+
- type
60829+
type: object
60830+
RuleBasedViewRuleCategory:
60831+
description: The category of the security rule.
60832+
enum:
60833+
- cloud_configuration
60834+
- infrastructure_configuration
60835+
- api_security
60836+
example: cloud_configuration
60837+
type: string
60838+
x-enum-varnames:
60839+
- CLOUD_CONFIGURATION
60840+
- INFRASTRUCTURE_CONFIGURATION
60841+
- API_SECURITY
60842+
RuleBasedViewRuleStats:
60843+
description: Counts of findings for the rule, grouped by their evaluation status.
60844+
properties:
60845+
fail:
60846+
description: Number of findings that failed evaluation.
60847+
example: 0
60848+
format: int64
60849+
type: integer
60850+
muted:
60851+
description: Number of findings that have been muted.
60852+
example: 0
60853+
format: int64
60854+
type: integer
60855+
pass:
60856+
description: Number of findings that passed evaluation.
60857+
example: 3
60858+
format: int64
60859+
type: integer
60860+
required:
60861+
- fail
60862+
- pass
60863+
- muted
60864+
type: object
60865+
RuleBasedViewRuleTags:
60866+
description: List of tags attached to the rule.
60867+
example:
60868+
- security:compliance
60869+
items:
60870+
description: A tag attached to the rule.
60871+
example: security:compliance
60872+
type: string
60873+
type: array
60874+
RuleBasedViewRules:
60875+
description: List of rules in the rule-based view.
60876+
items:
60877+
$ref: "#/components/schemas/RuleBasedViewRule"
60878+
type: array
60879+
RuleBasedViewType:
60880+
default: rule_based_view
60881+
description: The type of the resource. The value should always be `rule_based_view`.
60882+
enum:
60883+
- rule_based_view
60884+
example: rule_based_view
60885+
type: string
60886+
x-enum-varnames:
60887+
- RULE_BASED_VIEW
6063960888
RuleId:
6064060889
description: The unique ID for a scorecard rule.
6064160890
example: q8MQxk8TCqrHnWkx
@@ -95543,6 +95792,89 @@ paths:
9554395792
x-unstable: |-
9554495793
**Note**: This endpoint is in preview and may be subject to change.
9554595794
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
95795+
/api/v2/compliance_findings/rule_based_view:
95796+
get:
95797+
description: |-
95798+
Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
95799+
Supports filtering by compliance framework, framework version, and additional query filters.
95800+
operationId: GetRuleBasedView
95801+
parameters:
95802+
- $ref: "#/components/parameters/RuleBasedViewTo"
95803+
- $ref: "#/components/parameters/RuleBasedViewFramework"
95804+
- $ref: "#/components/parameters/RuleBasedViewVersion"
95805+
- $ref: "#/components/parameters/RuleBasedViewQueryFindingsWithoutFrameworkVersion"
95806+
- $ref: "#/components/parameters/RuleBasedViewIncludeRulesWithoutFindings"
95807+
- $ref: "#/components/parameters/RuleBasedViewIsCustom"
95808+
- $ref: "#/components/parameters/RuleBasedViewQuery"
95809+
responses:
95810+
"200":
95811+
content:
95812+
application/json:
95813+
examples:
95814+
default:
95815+
value:
95816+
data:
95817+
attributes:
95818+
count: 1
95819+
rules:
95820+
- compliance_frameworks:
95821+
- control: 164.308-a-4-i
95822+
framework: hipaa
95823+
is_default: true
95824+
message: ""
95825+
requirement: Information-Access-Management
95826+
version: "1"
95827+
enabled: true
95828+
id: qjx-udx-xo8
95829+
name: IAM roles should not allow untrusted GitHub Actions to assume them
95830+
resourceAttributes: []
95831+
resourceCategory: identity
95832+
resourceType: aws_iam_role
95833+
stats:
95834+
fail: 0
95835+
muted: 0
95836+
pass: 3
95837+
status: critical
95838+
tags:
95839+
- security:compliance
95840+
- cloud_provider:aws
95841+
- framework:hipaa
95842+
type: cloud_configuration
95843+
id: JSONAPI_USELESS_ID
95844+
type: rule_based_view
95845+
schema:
95846+
$ref: "#/components/schemas/RuleBasedViewResponse"
95847+
description: OK
95848+
"400":
95849+
content:
95850+
application/json:
95851+
schema:
95852+
$ref: "#/components/schemas/JSONAPIErrorResponse"
95853+
description: Bad Request
95854+
"403":
95855+
$ref: "#/components/responses/NotAuthorizedResponse"
95856+
"429":
95857+
$ref: "#/components/responses/TooManyRequestsResponse"
95858+
"503":
95859+
content:
95860+
application/json:
95861+
schema:
95862+
$ref: "#/components/schemas/JSONAPIErrorResponse"
95863+
description: Service Unavailable
95864+
security:
95865+
- apiKeyAuth: []
95866+
appKeyAuth: []
95867+
- AuthZ:
95868+
- security_monitoring_findings_read
95869+
summary: Get the rule-based view of compliance findings
95870+
tags: ["Compliance"]
95871+
"x-permission":
95872+
operator: OR
95873+
permissions:
95874+
- security_monitoring_findings_read
95875+
x-unstable: |-
95876+
**Note**: This endpoint is in Preview and subject to change.
95877+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
9554695878
/api/v2/container_images:
9554795879
get:
9554895880
description: |-
@@ -148009,6 +148341,12 @@ tags:
148009148341
- description: |-
148010148342
Retrieve and analyze code coverage data from Code Coverage. See the [Code Coverage page](https://docs.datadoghq.com/code_coverage/) for more information.
148011148343
name: Code Coverage
148344+
- description: |-
148345+
Datadog Cloud Security Misconfigurations provides aggregated views of
148346+
compliance rules and findings across your cloud resources, helping you assess
148347+
posture against industry frameworks (such as HIPAA, SOC 2, ISO 27001) and custom
148348+
frameworks. Learn more at https://docs.datadoghq.com/security/cloud_security_management/misconfigurations/#maintain-compliance-with-industry-frameworks-and-benchmarks.
148349+
name: "Compliance"
148012148350
- description: |-
148013148351
Manage your Datadog Confluent Cloud integration accounts and account resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/) for more information.
148014148352
name: Confluent Cloud

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,13 @@ datadog\_api\_client.v2.api.code\_coverage\_api module
172172
:members:
173173
:show-inheritance:
174174

175+
datadog\_api\_client.v2.api.compliance\_api module
176+
--------------------------------------------------
177+
178+
.. automodule:: datadog_api_client.v2.api.compliance_api
179+
:members:
180+
:show-inheritance:
181+
175182
datadog\_api\_client.v2.api.confluent\_cloud\_api module
176183
--------------------------------------------------------
177184

0 commit comments

Comments
 (0)