Disable a default inbox rule for the current organization.
This endpoint requires the security_pipelines_write permission.
Arguments
Path Parameters
Name
Type
Description
rule_id [required]
string
The ID of the default inbox rule.
Known default rule IDs include: identity_risk_default_rule,
secret_default_rule, library_vulnerability_default_rule,
attack_path_default_rule, host_and_container_vulnerability_default_rule,
runtime_code_vulnerability_default_rule, iac_misconfiguration_default_rule,
and misconfiguration_default_rule. Datadog can add new default rules
over time.
The data object for a default inbox rule returned by the API.
attributes [required]
object
Attributes of a default inbox rule returned by the API.
action [required]
object
The action to take when the inbox rule matches a finding.
description
string
An optional description providing more context for the rule.
created_at [required]
int64
The Unix timestamp in milliseconds when the rule definition was created. The definition is authored by Datadog.
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 default inbox rule is enabled for the organization.
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 default inbox 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]
string
The ID of the default inbox rule.
Known default rule IDs include: identity_risk_default_rule,
secret_default_rule, library_vulnerability_default_rule,
attack_path_default_rule, host_and_container_vulnerability_default_rule,
runtime_code_vulnerability_default_rule, iac_misconfiguration_default_rule,
and misconfiguration_default_rule. Datadog can add new default rules
over time.
type [required]
enum
The JSON:API type for default inbox rules.
Allowed enum values: default_inbox_rules
# Path parameters exportrule_id="secret_default_rule" # Use a Personal Access Token or Service Access Token exportDD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"python3"example.py"
# Disable a default inbox rule returns "Successfully disabled the default inbox rule" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]config.unstable_operations["v2.disable_security_findings_automation_default_inbox_rule".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newpapi_instance.disable_security_findings_automation_default_inbox_rule("secret_default_rule")
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"rb"example.rb"
// Disable a default inbox rule returns "Successfully disabled the default inbox 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")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())ctx=context.WithValue(ctx,datadog.ContextAccessToken,os.Getenv("DD_BEARER_TOKEN"))configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.DisableSecurityFindingsAutomationDefaultInboxRule",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.DisableSecurityFindingsAutomationDefaultInboxRule(ctx,"secret_default_rule")iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.DisableSecurityFindingsAutomationDefaultInboxRule`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.DisableSecurityFindingsAutomationDefaultInboxRule`:\n%s\n",responseContent)}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"go run"main.go"
// Disable a default inbox rule returns "Successfully disabled the default inbox rule" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.DefaultInboxRuleResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));defaultClient.setUnstableOperationEnabled("v2.disableSecurityFindingsAutomationDefaultInboxRule",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);try{DefaultInboxRuleResponseresult=apiInstance.disableSecurityFindingsAutomationDefaultInboxRule("secret_default_rule");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling"+" SecurityMonitoringApi#disableSecurityFindingsAutomationDefaultInboxRule");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"java"Example.java"
// Disable a default inbox rule returns "Successfully disabled the default inbox
// rule" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.DisableSecurityFindingsAutomationDefaultInboxRule",true,);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.disable_security_findings_automation_default_inbox_rule("secret_default_rule".to_string()).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
/**
* Disable a default inbox rule returns "Successfully disabled the default inbox rule" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});configuration.unstableOperations["v2.disableSecurityFindingsAutomationDefaultInboxRule"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);constparams: v2.SecurityMonitoringApiDisableSecurityFindingsAutomationDefaultInboxRuleRequest={ruleId:"secret_default_rule",};apiInstance.disableSecurityFindingsAutomationDefaultInboxRule(params).then((data: v2.DefaultInboxRuleResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"tsc"example.ts"
Request a personalized demo
Get Started with Datadog
Ask AI
AI-generated responses may be inaccurate. Verify important info.