The data object for a mute rule returned by the API.
attributes [required]
object
Attributes of a mute rule returned by the API.
action [required]
object
The action to take when the mute rule matches a finding.
expire_at
int64
The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.
reason [required]
enum
The reason for muting a security finding.
Allowed enum values: duplicate,false_positive,no_fix,other,pending_fix,risk_accepted
reason_description
string
An optional description providing more context for the mute reason.
created_at [required]
int64
The Unix timestamp in milliseconds when the rule was created.
created_by [required]
object
The user or Datadog system who created the rule.
id [required]
string
The actor's identifier (a user UUID or a system identifier).
name [required]
string
The name of the actor.
type [required]
enum
Whether the actor is a user or the Datadog system.
Allowed enum values: user,system
enabled [required]
boolean
Whether the mute rule is enabled.
modified_at [required]
int64
The Unix timestamp in milliseconds when the rule was last modified.
modified_by [required]
object
The user or Datadog system who last modified the rule.
id [required]
string
The actor's identifier (a user UUID or a system identifier).
name [required]
string
The name of the actor.
type [required]
enum
Whether the actor is a user or the Datadog system.
Allowed enum values: user,system
name [required]
string
The name of the mute rule.
rule [required]
object
Defines the scope of findings to which the automation rule applies.
finding_types [required]
[string]
The list of security finding types that the automation rule applies to.
query
string
A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.
id [required]
uuid
The ID of the mute rule.
type [required]
enum
The JSON:API type for mute rules.
Allowed enum values: mute_rules
{"data":{"attributes":{"action":{"expire_at":4070908800000,"reason":"risk_accepted","reason_description":"Accepted for dev environments only"},"created_at":1722439510282,"created_by":{"id":"00000000-0000-0000-0000-000000000000","name":"Jane Doe","type":"user"},"enabled":true,"modified_at":1722439510282,"modified_by":{"id":"00000000-0000-0000-0000-000000000000","name":"Jane Doe","type":"user"},"name":"Mute accepted risks in dev","rule":{"finding_types":["misconfiguration"],"query":"env:prod team:platform"}},"id":"00000000-0000-0000-0000-000000000000","type":"mute_rules"}}
"""
Get a mute rule returns "Successfully retrieved the mute rule" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApi# there is a valid "valid_mute_rule" in the systemVALID_MUTE_RULE_DATA_ID=environ["VALID_MUTE_RULE_DATA_ID"]configuration=Configuration()configuration.unstable_operations["get_security_findings_automation_mute_rule"]=TruewithApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.get_security_findings_automation_mute_rule(rule_id=VALID_MUTE_RULE_DATA_ID,)print(response)
# Get a mute rule returns "Successfully retrieved the mute rule" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.get_security_findings_automation_mute_rule".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.new# there is a valid "valid_mute_rule" in the systemVALID_MUTE_RULE_DATA_ID=ENV["VALID_MUTE_RULE_DATA_ID"]papi_instance.get_security_findings_automation_mute_rule(VALID_MUTE_RULE_DATA_ID)
// Get a mute rule returns "Successfully retrieved the mute rule" 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""github.com/google/uuid")funcmain(){// there is a valid "valid_mute_rule" in the systemValidMuteRuleDataID:=uuid.MustParse(os.Getenv("VALID_MUTE_RULE_DATA_ID"))ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetSecurityFindingsAutomationMuteRule",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.GetSecurityFindingsAutomationMuteRule(ctx,ValidMuteRuleDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.GetSecurityFindingsAutomationMuteRule`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.GetSecurityFindingsAutomationMuteRule`:\n%s\n",responseContent)}
// Get a mute rule returns "Successfully retrieved the mute rule" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.MuteRuleResponse;importjava.util.UUID;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.getSecurityFindingsAutomationMuteRule",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);// there is a valid "valid_mute_rule" in the systemUUIDVALID_MUTE_RULE_DATA_ID=null;try{VALID_MUTE_RULE_DATA_ID=UUID.fromString(System.getenv("VALID_MUTE_RULE_DATA_ID"));}catch(IllegalArgumentExceptione){System.err.println("Error parsing UUID: "+e.getMessage());}try{MuteRuleResponseresult=apiInstance.getSecurityFindingsAutomationMuteRule(VALID_MUTE_RULE_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#getSecurityFindingsAutomationMuteRule");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a mute rule returns "Successfully retrieved the mute rule" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){// there is a valid "valid_mute_rule" in the system
letvalid_mute_rule_data_id=uuid::Uuid::parse_str(&std::env::var("VALID_MUTE_RULE_DATA_ID").unwrap()).expect("Invalid UUID");letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetSecurityFindingsAutomationMuteRule",true);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.get_security_findings_automation_mute_rule(valid_mute_rule_data_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a mute rule returns "Successfully retrieved the mute rule" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getSecurityFindingsAutomationMuteRule"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);// there is a valid "valid_mute_rule" in the system
constVALID_MUTE_RULE_DATA_ID=process.env.VALID_MUTE_RULE_DATA_IDasstring;constparams: v2.SecurityMonitoringApiGetSecurityFindingsAutomationMuteRuleRequest={ruleId: VALID_MUTE_RULE_DATA_ID,};apiInstance.getSecurityFindingsAutomationMuteRule(params).then((data: v2.MuteRuleResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));