Cette page n'est pas encore disponible en français, sa traduction est en cours. Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.
Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
Supports filtering by compliance framework, framework version, and additional query filters.
This endpoint requires the security_monitoring_findings_read permission.
OAuth apps require the security_monitoring_findings_read authorization scope to access this endpoint.
Arguments
Chaînes de requête
Nom
Type
Description
to [required]
integer
Timestamp of the query end, in milliseconds since the Unix epoch.
framework
string
Compliance framework handle to filter rules and findings by.
version
string
Version of the compliance framework to filter rules and findings by.
query_findings_without_framework_version
boolean
When true, returns findings without a framework_version tag. Used for findings from custom frameworks or those created before framework versioning was introduced.
include_rules_without_findings
boolean
When true, includes rules in the response that have no associated findings.
is_custom
boolean
Set to true when the requested framework is a custom framework.
query
string
Additional event-platform filters applied to the underlying findings query. For example, scored:true project_id:datadog-prod-us5.
Response containing an aggregated view of compliance rules with their finding statistics.
Expand All
Champ
Type
Description
data [required]
object
Data envelope for the rule-based view response.
attributes [required]
object
Attributes of the rule-based view.
count [required]
int64
Total number of rules in the view.
rules [required]
[object]
List of rules in the rule-based view.
compliance_frameworks [required]
[object]
List of compliance framework mappings associated with the rule.
control
string
Identifier of the control inside the requirement.
framework
string
Handle of the compliance framework.
is_default
boolean
Whether the framework is a Datadog default framework. true indicates a Datadog framework and false indicates a custom framework.
message
string
Optional message describing the framework mapping for the rule.
requirement
string
Name of the requirement that contains the control.
version
string
Version of the compliance framework.
enabled [required]
boolean
Whether the rule is enabled.
id [required]
string
Unique identifier of the rule.
name [required]
string
Human-readable name of the rule.
resourceAttributes [required]
[string]
List of resource attribute names exposed by the rule.
resourceCategory [required]
string
Resource category targeted by the rule.
resourceType [required]
string
Resource type targeted by the rule.
stats [required]
object
Counts of findings for the rule, grouped by their evaluation status.
fail [required]
int64
Number of findings that failed evaluation.
muted [required]
int64
Number of findings that have been muted.
pass [required]
int64
Number of findings that passed evaluation.
status [required]
string
Severity associated with the rule (for example, info, low, medium, high, or critical).
tags [required]
[string]
List of tags attached to the rule.
type [required]
enum
The category of the security rule.
Allowed enum values: cloud_configuration,infrastructure_configuration,api_security
id [required]
string
Unique identifier of the rule-based view document.
type [required]
enum
The type of the resource. The value should always be rule_based_view.
Allowed enum values: rule_based_view
default: rule_based_view
{"data":{"attributes":{"count":1,"rules":[{"compliance_frameworks":[{"control":"164.308-a-4-i","framework":"hipaa","is_default":true,"message":"","requirement":"Information-Access-Management","version":"1"}],"enabled":true,"id":"qjx-udx-xo8","name":"IAM roles should not allow untrusted GitHub Actions to assume them","resourceAttributes":["instance_id"],"resourceCategory":"identity","resourceType":"aws_iam_role","stats":{"fail":0,"muted":0,"pass":3},"status":"critical","tags":["security:compliance"],"type":"cloud_configuration"}]},"id":"JSONAPI_USELESS_ID","type":"rule_based_view"}}
"""
Get the rule-based view of compliance findings returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.compliance_apiimportComplianceApiconfiguration=Configuration()configuration.unstable_operations["get_rule_based_view"]=TruewithApiClient(configuration)asapi_client:api_instance=ComplianceApi(api_client)response=api_instance.get_rule_based_view(to=1739982278000,)print(response)
# Get the rule-based view of compliance findings returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.get_rule_based_view".to_sym]=trueendapi_instance=DatadogAPIClient::V2::ComplianceAPI.newpapi_instance.get_rule_based_view(1739982278000)
// Get the rule-based view of compliance findings returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetRuleBasedView",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewComplianceApi(apiClient)resp,r,err:=api.GetRuleBasedView(ctx,1739982278000,*datadogV2.NewGetRuleBasedViewOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ComplianceApi.GetRuleBasedView`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ComplianceApi.GetRuleBasedView`:\n%s\n",responseContent)}
// Get the rule-based view of compliance findings returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ComplianceApi;importcom.datadog.api.client.v2.model.RuleBasedViewResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.getRuleBasedView",true);ComplianceApiapiInstance=newComplianceApi(defaultClient);try{RuleBasedViewResponseresult=apiInstance.getRuleBasedView(1739982278000L);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ComplianceApi#getRuleBasedView");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get the rule-based view of compliance findings returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_compliance::ComplianceAPI;usedatadog_api_client::datadogV2::api_compliance::GetRuleBasedViewOptionalParams;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetRuleBasedView",true);letapi=ComplianceAPI::with_config(configuration);letresp=api.get_rule_based_view(1739982278000,GetRuleBasedViewOptionalParams::default()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get the rule-based view of compliance findings returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getRuleBasedView"]=true;constapiInstance=newv2.ComplianceApi(configuration);constparams: v2.ComplianceApiGetRuleBasedViewRequest={to: 1739982278000,};apiInstance.getRuleBasedView(params).then((data: v2.RuleBasedViewResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));