Object containing the attributes of the suppression rule to be created.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
enabled [required]
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name [required]
string
The name of the suppression rule.
rule_query [required]
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.
type [required]
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
default: suppressions
{"data":{"attributes":{"description":"This rule suppresses low-severity signals in staging environments.","enabled":true,"start_date":1637493071000,"expiration_date":1638443471000,"name":"Example-Security-Monitoring","rule_query":"type:log_detection source:cloudtrail","suppression_query":"env:staging status:low"},"type":"suppressions"}}
{"data":{"attributes":{"description":"This rule suppresses low-severity signals in staging environments.","enabled":true,"start_date":1637493071000,"expiration_date":1638443471000,"name":"Example-Security-Monitoring","rule_query":"type:log_detection source:cloudtrail","data_exclusion_query":"account_id:12345"},"type":"suppressions"}}
Response object containing a single suppression rule.
Expand All
Field
Type
Description
data
object
The suppression rule's properties.
attributes
object
The attributes of the suppression rule.
creation_date
int64
A Unix millisecond timestamp given the creation date of the suppression rule.
creator
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
editable
boolean
Whether the suppression rule is editable.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
update_date
int64
A Unix millisecond timestamp given the update date of the suppression rule.
updater
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
version
int32
The version of the suppression rule; it starts at 1, and is incremented at each update.
id
string
The ID of the suppression rule.
type
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
# Create a suppression rule returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newbody=DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateRequest.new({data:DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateData.new({attributes:DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateAttributes.new({description:"This rule suppresses low-severity signals in staging environments.",enabled:true,start_date:1637493071000,expiration_date:1638443471000,name:"Example-Security-Monitoring",rule_query:"type:log_detection source:cloudtrail",suppression_query:"env:staging status:low",}),type:DatadogAPIClient::V2::SecurityMonitoringSuppressionType::SUPPRESSIONS,}),})papi_instance.create_security_monitoring_suppression(body)
# Create a suppression rule with an exclusion query returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newbody=DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateRequest.new({data:DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateData.new({attributes:DatadogAPIClient::V2::SecurityMonitoringSuppressionCreateAttributes.new({description:"This rule suppresses low-severity signals in staging environments.",enabled:true,start_date:1637493071000,expiration_date:1638443471000,name:"Example-Security-Monitoring",rule_query:"type:log_detection source:cloudtrail",data_exclusion_query:"account_id:12345",}),type:DatadogAPIClient::V2::SecurityMonitoringSuppressionType::SUPPRESSIONS,}),})papi_instance.create_security_monitoring_suppression(body)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Create a suppression rule returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);constparams: v2.SecurityMonitoringApiCreateSecurityMonitoringSuppressionRequest={body:{data:{attributes:{description:"This rule suppresses low-severity signals in staging environments.",enabled: true,startDate: 1637493071000,expirationDate: 1638443471000,name:"Example-Security-Monitoring",ruleQuery:"type:log_detection source:cloudtrail",suppressionQuery:"env:staging status:low",},type:"suppressions",},},};apiInstance.createSecurityMonitoringSuppression(params).then((data: v2.SecurityMonitoringSuppressionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Create a suppression rule with an exclusion query returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);constparams: v2.SecurityMonitoringApiCreateSecurityMonitoringSuppressionRequest={body:{data:{attributes:{description:"This rule suppresses low-severity signals in staging environments.",enabled: true,startDate: 1637493071000,expirationDate: 1638443471000,name:"Example-Security-Monitoring",ruleQuery:"type:log_detection source:cloudtrail",dataExclusionQuery:"account_id:12345",},type:"suppressions",},},};apiInstance.createSecurityMonitoringSuppression(params).then((data: v2.SecurityMonitoringSuppressionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
Delete a suppression rule returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApi# there is a valid "suppression" in the systemSUPPRESSION_DATA_ID=environ["SUPPRESSION_DATA_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)api_instance.delete_security_monitoring_suppression(suppression_id=SUPPRESSION_DATA_ID,)
# Delete a suppression rule returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.new# there is a valid "suppression" in the systemSUPPRESSION_DATA_ID=ENV["SUPPRESSION_DATA_ID"]api_instance.delete_security_monitoring_suppression(SUPPRESSION_DATA_ID)
// Delete a suppression rule returns "OK" response
packagemainimport("context""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){// there is a valid "suppression" in the system
SuppressionDataID:=os.Getenv("SUPPRESSION_DATA_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)r,err:=api.DeleteSecurityMonitoringSuppression(ctx,SuppressionDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.DeleteSecurityMonitoringSuppression`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}}
// Delete a suppression rule returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);// there is a valid "suppression" in the systemStringSUPPRESSION_DATA_ID=System.getenv("SUPPRESSION_DATA_ID");try{apiInstance.deleteSecurityMonitoringSuppression(SUPPRESSION_DATA_ID);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#deleteSecurityMonitoringSuppression");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Delete a suppression rule returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){// there is a valid "suppression" in the system
letsuppression_data_id=std::env::var("SUPPRESSION_DATA_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.delete_security_monitoring_suppression(suppression_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.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Delete a suppression rule returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);// there is a valid "suppression" in the system
constSUPPRESSION_DATA_ID=process.env.SUPPRESSION_DATA_IDasstring;constparams: v2.SecurityMonitoringApiDeleteSecurityMonitoringSuppressionRequest={suppressionId: SUPPRESSION_DATA_ID,};apiInstance.deleteSecurityMonitoringSuppression(params).then((data: any)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Response object containing a single suppression rule.
Expand All
Field
Type
Description
data
object
The suppression rule's properties.
attributes
object
The attributes of the suppression rule.
creation_date
int64
A Unix millisecond timestamp given the creation date of the suppression rule.
creator
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
editable
boolean
Whether the suppression rule is editable.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
update_date
int64
A Unix millisecond timestamp given the update date of the suppression rule.
updater
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
version
int32
The version of the suppression rule; it starts at 1, and is incremented at each update.
id
string
The ID of the suppression rule.
type
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
"""
Get a suppression rule returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApi# there is a valid "suppression" in the systemSUPPRESSION_DATA_ID=environ["SUPPRESSION_DATA_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.get_security_monitoring_suppression(suppression_id=SUPPRESSION_DATA_ID,)print(response)
# Get a suppression rule returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.new# there is a valid "suppression" in the systemSUPPRESSION_DATA_ID=ENV["SUPPRESSION_DATA_ID"]papi_instance.get_security_monitoring_suppression(SUPPRESSION_DATA_ID)
// Get a suppression rule returns "OK" response
packagemainimport("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(){// there is a valid "suppression" in the system
SuppressionDataID:=os.Getenv("SUPPRESSION_DATA_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.GetSecurityMonitoringSuppression(ctx,SuppressionDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.GetSecurityMonitoringSuppression`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.GetSecurityMonitoringSuppression`:\n%s\n",responseContent)}
// Get a suppression rule returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.SecurityMonitoringSuppressionResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);// there is a valid "suppression" in the systemStringSUPPRESSION_DATA_ID=System.getenv("SUPPRESSION_DATA_ID");try{SecurityMonitoringSuppressionResponseresult=apiInstance.getSecurityMonitoringSuppression(SUPPRESSION_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#getSecurityMonitoringSuppression");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a suppression rule returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){// there is a valid "suppression" in the system
letsuppression_data_id=std::env::var("SUPPRESSION_DATA_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.get_security_monitoring_suppression(suppression_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.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a suppression rule returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);// there is a valid "suppression" in the system
constSUPPRESSION_DATA_ID=process.env.SUPPRESSION_DATA_IDasstring;constparams: v2.SecurityMonitoringApiGetSecurityMonitoringSuppressionRequest={suppressionId: SUPPRESSION_DATA_ID,};apiInstance.getSecurityMonitoringSuppression(params).then((data: v2.SecurityMonitoringSuppressionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Response object containing the available suppression rules.
Expand All
Field
Type
Description
data
[object]
A list of suppressions objects.
attributes
object
The attributes of the suppression rule.
creation_date
int64
A Unix millisecond timestamp given the creation date of the suppression rule.
creator
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
editable
boolean
Whether the suppression rule is editable.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
update_date
int64
A Unix millisecond timestamp given the update date of the suppression rule.
updater
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
version
int32
The version of the suppression rule; it starts at 1, and is incremented at each update.
id
string
The ID of the suppression rule.
type
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
"""
Get all suppression rules returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.list_security_monitoring_suppressions()print(response)
# Get all suppression rules returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newpapi_instance.list_security_monitoring_suppressions()
// Get all suppression rules returns "OK" response
packagemainimport("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()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.ListSecurityMonitoringSuppressions(ctx)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.ListSecurityMonitoringSuppressions`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.ListSecurityMonitoringSuppressions`:\n%s\n",responseContent)}
// Get all suppression rules returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.list_security_monitoring_suppressions().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.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get all suppression rules returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);apiInstance.listSecurityMonitoringSuppressions().then((data: v2.SecurityMonitoringSuppressionsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Response object containing the available suppression rules.
Expand All
Field
Type
Description
data
[object]
A list of suppressions objects.
attributes
object
The attributes of the suppression rule.
creation_date
int64
A Unix millisecond timestamp given the creation date of the suppression rule.
creator
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
editable
boolean
Whether the suppression rule is editable.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
update_date
int64
A Unix millisecond timestamp given the update date of the suppression rule.
updater
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
version
int32
The version of the suppression rule; it starts at 1, and is incremented at each update.
id
string
The ID of the suppression rule.
type
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
expression [required]
string
Expression.
name [required]
string
Field name.
cases [required]
[object]
Cases for generating signals.
actions
[object]
Action to perform for each rule case.
options
object
Options for the rule action
duration
int64
Duration of the action in seconds. 0 indicates no expiration.
flaggedIPType
enum
Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.
Allowed enum values: SUSPICIOUS,FLAGGED
userBehaviorName
string
Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.
type
enum
The action type.
Allowed enum values: block_ip,block_user,user_behavior,flag_ip
condition
string
A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated
based on the event counts in the previously defined queries.
name
string
Name of the case.
notifications
[string]
Notification targets.
status [required]
enum
Severity of the Security Signal.
Allowed enum values: info,low,medium,high,critical
filters
[object]
Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
action
enum
The type of filtering action.
Allowed enum values: require,suppress
query
string
Query for selecting logs to apply the filtering action.
groupSignalsBy
[string]
Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
hasExtendedTitle
boolean
Whether the notifications include the triggering group-by values in their title.
isEnabled [required]
boolean
Whether the rule is enabled.
message [required]
string
Message for generated signals.
name [required]
string
The name of the rule.
options [required]
object
Options.
complianceRuleOptions
object
Options for cloud_configuration rules.
Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.
complexRule
boolean
Whether the rule is a complex one.
Must be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.
List of resource types that will be evaluated upon. Must have at least one element.
resourceType
string
Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.
decreaseCriticalityBasedOnEnv
boolean
If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.
The severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.
The decrement is applied when the environment tag of the signal starts with staging, test or dev.
detectionMethod
enum
The detection method.
Allowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold
evaluationWindow
enum
A time window is specified to match when at least one of the cases matches true. This is a sliding window
and evaluates in real time. For third party detection method, this field is not used.
Allowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400
If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular
access locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.
keepAlive
enum
Once a signal is generated, the signal will remain "open" if a case is matched at least once within
this keep alive window. For third party detection method, this field is not used.
Allowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400
maxSignalDuration
enum
A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.
This time is calculated from the first seen timestamp.
Allowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400
newValueOptions
object
Options on new value detection method.
forgetAfter
enum
The duration in days after which a learned value is forgotten.
Allowed enum values: 1,2,7,14,21,28
learningDuration
enum
The duration in days during which values are learned, and after which signals will be generated for values that
weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.
Allowed enum values: 0,1,7
learningMethod
enum
The learning method used to determine when signals should be generated for values that weren't learned.
Allowed enum values: duration,threshold
default: duration
learningThreshold
enum
A number of occurrences after which signals will be generated for values that weren't learned.
Allowed enum values: 0,1
thirdPartyRuleOptions
object
Options on third party detection method.
defaultNotifications
[string]
Notification targets for the logs that do not correspond to any of the cases.
defaultStatus
enum
Severity of the Security Signal.
Allowed enum values: info,low,medium,high,critical
rootQueries
[object]
Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.
groupByFields
[string]
Fields to group by.
query
string
Query to run on logs.
signalTitleTemplate
string
A template for the signal title; if omitted, the title is generated based on the case name.
queries [required]
[object]
Queries for selecting logs which are part of the rule.
aggregation
enum
The aggregation type.
Allowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none
customQueryExtension
string
Query extension to append to the logs query.
dataSource
enum
Source of events, either logs, audit trail, or Datadog events.
Allowed enum values: logs,audit,app_sec_spans,spans,security_runtime,network,events
default: logs
distinctFields
[string]
Field for which the cardinality is measured. Sent as an array.
groupByFields
[string]
Fields to group by.
hasOptionalGroupByFields
boolean
When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.
index
string
This field is currently unstable and might be removed in a minor version upgrade.
The index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.
metric
string
DEPRECATED: (Deprecated) The target field to aggregate over when using the sum or max
aggregations. metrics field should be used instead.
metrics
[string]
Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
name
string
Name of the query.
query
string
Query to run on logs.
referenceTables
[object]
Reference tables for the rule.
checkPresence
boolean
Whether to include or exclude the matched values.
columnName
string
The name of the column in the reference table.
logFieldPath
string
The field in the log to match against the reference table.
ruleQueryName
string
The name of the query to apply the reference table to.
tableName
string
The name of the reference table.
schedulingOptions
object
Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
rrule
string
Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.
start
string
Start date for the schedule, in ISO 8601 format without timezone.
timezone
string
Time zone of the start date, in the tz database format.
tags
[string]
Tags for generated signals.
thirdPartyCases
[object]
Cases for generating signals from third-party rules. Only available for third-party rules.
name
string
Name of the case.
notifications
[string]
Notification targets for each case.
query
string
A query to map a third party event to this case.
status [required]
enum
Severity of the Security Signal.
Allowed enum values: info,low,medium,high,critical
type
enum
The rule type.
Allowed enum values: api_security,application_security,log_detection,workload_security
Option 2
object
Create a new signal correlation rule.
cases [required]
[object]
Cases for generating signals.
actions
[object]
Action to perform for each rule case.
options
object
Options for the rule action
duration
int64
Duration of the action in seconds. 0 indicates no expiration.
flaggedIPType
enum
Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.
Allowed enum values: SUSPICIOUS,FLAGGED
userBehaviorName
string
Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.
type
enum
The action type.
Allowed enum values: block_ip,block_user,user_behavior,flag_ip
condition
string
A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated
based on the event counts in the previously defined queries.
name
string
Name of the case.
notifications
[string]
Notification targets.
status [required]
enum
Severity of the Security Signal.
Allowed enum values: info,low,medium,high,critical
filters
[object]
Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
action
enum
The type of filtering action.
Allowed enum values: require,suppress
query
string
Query for selecting logs to apply the filtering action.
hasExtendedTitle
boolean
Whether the notifications include the triggering group-by values in their title.
isEnabled [required]
boolean
Whether the rule is enabled.
message [required]
string
Message for generated signals.
name [required]
string
The name of the rule.
options [required]
object
Options.
complianceRuleOptions
object
Options for cloud_configuration rules.
Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.
complexRule
boolean
Whether the rule is a complex one.
Must be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.
List of resource types that will be evaluated upon. Must have at least one element.
resourceType
string
Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.
decreaseCriticalityBasedOnEnv
boolean
If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.
The severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.
The decrement is applied when the environment tag of the signal starts with staging, test or dev.
detectionMethod
enum
The detection method.
Allowed enum values: threshold,new_value,anomaly_detection,impossible_travel,hardcoded,third_party,anomaly_threshold
evaluationWindow
enum
A time window is specified to match when at least one of the cases matches true. This is a sliding window
and evaluates in real time. For third party detection method, this field is not used.
Allowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400
If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular
access locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.
keepAlive
enum
Once a signal is generated, the signal will remain "open" if a case is matched at least once within
this keep alive window. For third party detection method, this field is not used.
Allowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400
maxSignalDuration
enum
A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.
This time is calculated from the first seen timestamp.
Allowed enum values: 0,60,300,600,900,1800,3600,7200,10800,21600,43200,86400
newValueOptions
object
Options on new value detection method.
forgetAfter
enum
The duration in days after which a learned value is forgotten.
Allowed enum values: 1,2,7,14,21,28
learningDuration
enum
The duration in days during which values are learned, and after which signals will be generated for values that
weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.
Allowed enum values: 0,1,7
learningMethod
enum
The learning method used to determine when signals should be generated for values that weren't learned.
Allowed enum values: duration,threshold
default: duration
learningThreshold
enum
A number of occurrences after which signals will be generated for values that weren't learned.
Allowed enum values: 0,1
thirdPartyRuleOptions
object
Options on third party detection method.
defaultNotifications
[string]
Notification targets for the logs that do not correspond to any of the cases.
defaultStatus
enum
Severity of the Security Signal.
Allowed enum values: info,low,medium,high,critical
rootQueries
[object]
Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.
groupByFields
[string]
Fields to group by.
query
string
Query to run on logs.
signalTitleTemplate
string
A template for the signal title; if omitted, the title is generated based on the case name.
queries [required]
[object]
Queries for selecting signals which are part of the rule.
aggregation
enum
The aggregation type.
Allowed enum values: count,cardinality,sum,max,new_value,geo_data,event_count,none
correlatedByFields
[string]
Fields to group by.
correlatedQueryIndex
int32
Index of the rule query used to retrieve the correlated field.
metrics
[string]
Group of target fields to aggregate over.
name
string
Name of the query.
ruleId [required]
string
Rule ID to match on signals.
tags
[string]
Tags for generated signals.
type
enum
The rule type.
Allowed enum values: signal_correlation
Option 3
object
Create a new cloud configuration rule.
cases [required]
[object]
Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.
notifications
[string]
Notification targets for each rule case.
status [required]
enum
Severity of the Security Signal.
Allowed enum values: info,low,medium,high,critical
complianceSignalOptions [required]
object
How to generate compliance signals. Useful for cloud_configuration rules only.
defaultActivationStatus
boolean
The default activation status.
defaultGroupByFields
[string]
The default group by fields.
userActivationStatus
boolean
Whether signals will be sent.
userGroupByFields
[string]
Fields to use to group findings by when sending signals.
filters
[object]
Additional queries to filter matched events before they are processed.
action
enum
The type of filtering action.
Allowed enum values: require,suppress
query
string
Query for selecting logs to apply the filtering action.
isEnabled [required]
boolean
Whether the rule is enabled.
message [required]
string
Message in markdown format for generated findings and signals.
name [required]
string
The name of the rule.
options [required]
object
Options on cloud configuration rules.
complianceRuleOptions [required]
object
Options for cloud_configuration rules.
Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.
complexRule
boolean
Whether the rule is a complex one.
Must be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.
Response object containing the available suppression rules.
Expand All
Field
Type
Description
data
[object]
A list of suppressions objects.
attributes
object
The attributes of the suppression rule.
creation_date
int64
A Unix millisecond timestamp given the creation date of the suppression rule.
creator
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
editable
boolean
Whether the suppression rule is editable.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
update_date
int64
A Unix millisecond timestamp given the update date of the suppression rule.
updater
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
version
int32
The version of the suppression rule; it starts at 1, and is incremented at each update.
id
string
The ID of the suppression rule.
type
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
The new suppression properties; partial updates are supported.
attributes [required]
object
The suppression rule properties to be updated.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. If unset, the expiration date of the suppression rule is left untouched. If set to null, the expiration date is removed.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to null, the start date is removed.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
version
int32
The current version of the suppression. This is optional, but it can help prevent concurrent modifications.
type [required]
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
Response object containing a single suppression rule.
Expand All
Field
Type
Description
data
object
The suppression rule's properties.
attributes
object
The attributes of the suppression rule.
creation_date
int64
A Unix millisecond timestamp given the creation date of the suppression rule.
creator
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
editable
boolean
Whether the suppression rule is editable.
enabled
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name
string
The name of the suppression rule.
rule_query
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
update_date
int64
A Unix millisecond timestamp given the update date of the suppression rule.
updater
object
A user.
handle
string
The handle of the user.
name
string
The name of the user.
version
int32
The version of the suppression rule; it starts at 1, and is incremented at each update.
id
string
The ID of the suppression rule.
type
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
// Update a suppression rule returns "OK" response
packagemainimport("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(){// there is a valid "suppression" in the system
SuppressionDataID:=os.Getenv("SUPPRESSION_DATA_ID")body:=datadogV2.SecurityMonitoringSuppressionUpdateRequest{Data:datadogV2.SecurityMonitoringSuppressionUpdateData{Attributes:datadogV2.SecurityMonitoringSuppressionUpdateAttributes{SuppressionQuery:datadog.PtrString("env:staging status:low"),},Type:datadogV2.SECURITYMONITORINGSUPPRESSIONTYPE_SUPPRESSIONS,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.UpdateSecurityMonitoringSuppression(ctx,SuppressionDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.UpdateSecurityMonitoringSuppression`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.UpdateSecurityMonitoringSuppression`:\n%s\n",responseContent)}
// Update a suppression rule returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.SecurityMonitoringSuppressionResponse;importcom.datadog.api.client.v2.model.SecurityMonitoringSuppressionType;importcom.datadog.api.client.v2.model.SecurityMonitoringSuppressionUpdateAttributes;importcom.datadog.api.client.v2.model.SecurityMonitoringSuppressionUpdateData;importcom.datadog.api.client.v2.model.SecurityMonitoringSuppressionUpdateRequest;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);// there is a valid "suppression" in the systemStringSUPPRESSION_DATA_ID=System.getenv("SUPPRESSION_DATA_ID");SecurityMonitoringSuppressionUpdateRequestbody=newSecurityMonitoringSuppressionUpdateRequest().data(newSecurityMonitoringSuppressionUpdateData().attributes(newSecurityMonitoringSuppressionUpdateAttributes().suppressionQuery("env:staging status:low")).type(SecurityMonitoringSuppressionType.SUPPRESSIONS));try{SecurityMonitoringSuppressionResponseresult=apiInstance.updateSecurityMonitoringSuppression(SUPPRESSION_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#updateSecurityMonitoringSuppression");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update a suppression rule returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApifromdatadog_api_client.v2.model.security_monitoring_suppression_typeimportSecurityMonitoringSuppressionTypefromdatadog_api_client.v2.model.security_monitoring_suppression_update_attributesimport(SecurityMonitoringSuppressionUpdateAttributes,)fromdatadog_api_client.v2.model.security_monitoring_suppression_update_dataimport(SecurityMonitoringSuppressionUpdateData,)fromdatadog_api_client.v2.model.security_monitoring_suppression_update_requestimport(SecurityMonitoringSuppressionUpdateRequest,)# there is a valid "suppression" in the systemSUPPRESSION_DATA_ID=environ["SUPPRESSION_DATA_ID"]body=SecurityMonitoringSuppressionUpdateRequest(data=SecurityMonitoringSuppressionUpdateData(attributes=SecurityMonitoringSuppressionUpdateAttributes(suppression_query="env:staging status:low",),type=SecurityMonitoringSuppressionType.SUPPRESSIONS,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.update_security_monitoring_suppression(suppression_id=SUPPRESSION_DATA_ID,body=body)print(response)
# Update a suppression rule returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.new# there is a valid "suppression" in the systemSUPPRESSION_DATA_ID=ENV["SUPPRESSION_DATA_ID"]body=DatadogAPIClient::V2::SecurityMonitoringSuppressionUpdateRequest.new({data:DatadogAPIClient::V2::SecurityMonitoringSuppressionUpdateData.new({attributes:DatadogAPIClient::V2::SecurityMonitoringSuppressionUpdateAttributes.new({suppression_query:"env:staging status:low",}),type:DatadogAPIClient::V2::SecurityMonitoringSuppressionType::SUPPRESSIONS,}),})papi_instance.update_security_monitoring_suppression(SUPPRESSION_DATA_ID,body)
// Update a suppression rule returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;usedatadog_api_client::datadogV2::model::SecurityMonitoringSuppressionType;usedatadog_api_client::datadogV2::model::SecurityMonitoringSuppressionUpdateAttributes;usedatadog_api_client::datadogV2::model::SecurityMonitoringSuppressionUpdateData;usedatadog_api_client::datadogV2::model::SecurityMonitoringSuppressionUpdateRequest;#[tokio::main]asyncfnmain(){// there is a valid "suppression" in the system
letsuppression_data_id=std::env::var("SUPPRESSION_DATA_ID").unwrap();letbody=SecurityMonitoringSuppressionUpdateRequest::new(SecurityMonitoringSuppressionUpdateData::new(SecurityMonitoringSuppressionUpdateAttributes::new().suppression_query("env:staging status:low".to_string()),SecurityMonitoringSuppressionType::SUPPRESSIONS,),);letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.update_security_monitoring_suppression(suppression_data_id.clone(),body).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.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update a suppression rule returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);// there is a valid "suppression" in the system
constSUPPRESSION_DATA_ID=process.env.SUPPRESSION_DATA_IDasstring;constparams: v2.SecurityMonitoringApiUpdateSecurityMonitoringSuppressionRequest={body:{data:{attributes:{suppressionQuery:"env:staging status:low",},type:"suppressions",},},suppressionId: SUPPRESSION_DATA_ID,};apiInstance.updateSecurityMonitoringSuppression(params).then((data: v2.SecurityMonitoringSuppressionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Object containing the attributes of the suppression rule to be created.
data_exclusion_query
string
An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description
string
A description for the suppression rule.
enabled [required]
boolean
Whether the suppression rule is enabled.
expiration_date
int64
A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.
name [required]
string
The name of the suppression rule.
rule_query [required]
string
The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date
int64
A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query
string
The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.
type [required]
enum
The type of the resource. The value should always be suppressions.
Allowed enum values: suppressions
Filtering on tags: ?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2
Here, attribute_key can be any of the filter keys described further below.
Query parameters of type integer support comparison operators (>, >=, <, <=). This is particularly useful when filtering by evaluation_changed_at or resource_discovery_timestamp. For example: ?filter[evaluation_changed_at]=>20123123121.
You can also use the negation operator on strings. For example, use filter[resource_type]=-aws* to filter for any non-AWS resources.
The operator must come after the equal sign. For example, to filter with the >= operator, add the operator after the equal sign: filter[evaluation_changed_at]=>=1678809373257.
Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. filter[status]=low&filter[status]=info) are not allowed.
The expected response schema when listing findings.
Expand All
Field
Type
Description
data [required]
[object]
Array of findings.
attributes
object
The JSON:API attributes of the finding.
datadog_link
string
The Datadog relative link for this finding.
description
string
The description and remediation steps for this finding.
evaluation
enum
The evaluation of the finding.
Allowed enum values: pass,fail
evaluation_changed_at
int64
The date on which the evaluation for this finding changed (Unix ms).
external_id
string
The cloud-based ID for the resource related to the finding.
mute
object
Information about the mute status of this finding.
description
string
Additional information about the reason why this finding is muted or unmuted.
expiration_date
int64
The expiration date of the mute or unmute action (Unix ms).
muted
boolean
Whether this finding is muted or unmuted.
reason
enum
The reason why this finding is muted or unmuted.
Allowed enum values: PENDING_FIX,FALSE_POSITIVE,ACCEPTED_RISK,NO_PENDING_FIX,HUMAN_ERROR,NO_LONGER_ACCEPTED_RISK,OTHER
start_date
int64
The start of the mute period.
uuid
string
The ID of the user who muted or unmuted this finding.
resource
string
The resource name of this finding.
resource_discovery_date
int64
The date on which the resource was discovered (Unix ms).
resource_type
string
The resource type of this finding.
rule
object
The rule that triggered this finding.
id
string
The ID of the rule that triggered this finding.
name
string
The name of the rule that triggered this finding.
status
enum
The status of the finding.
Allowed enum values: critical,high,medium,low,info
tags
[string]
The tags associated with this finding.
vulnerability_type
enum
The vulnerability type of the finding.
Allowed enum values: misconfiguration,attack_path,identity_risk,api_security
id
string
The unique ID for this finding.
type
enum
The JSON:API type for findings.
Allowed enum values: finding
default: finding
meta [required]
object
Metadata for pagination.
page
object
Pagination and findings count information.
cursor
string
The cursor used to paginate requests.
total_filtered_count
int64
The total count of findings after the filter has been applied.
snapshot_timestamp
int64
The point in time corresponding to the listed findings.
{"data":[{"attributes":{"datadog_link":"/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview","description":"## Remediation\n\n1. In the console, go to **Storage Account**.\n2. For each Storage Account, navigate to **Data Protection**.\n3. Select **Set soft delete enabled** and enter the number of days to retain soft deleted data.","evaluation":"pass","evaluation_changed_at":1678721573794,"external_id":"arn:aws:s3:::my-example-bucket","mute":{"description":"To be resolved later","expiration_date":1778721573794,"muted":true,"reason":"ACCEPTED_RISK","start_date":1678721573794,"uuid":"e51c9744-d158-11ec-ad23-da7ad0900002"},"resource":"my_resource_name","resource_discovery_date":1678721573794,"resource_type":"azure_storage_account","rule":{"id":"dv2-jzf-41i","name":"Soft delete is enabled for Azure Storage"},"status":"critical","tags":["cloud_provider:aws","myTag:myValue"],"vulnerability_type":"misconfiguration"},"id":"ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==","type":"finding"}],"meta":{"page":{"cursor":"eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=","total_filtered_count":213},"snapshot_timestamp":1678721573794}}
Bad Request: The server cannot process the request due to invalid syntax in the request.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* List findings returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.listFindings"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);apiInstance.listFindings().then((data: v2.ListFindingsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
The expected response schema when getting a finding.
Expand All
Field
Type
Description
data [required]
object
A single finding with with message and resource configuration.
attributes
object
The JSON:API attributes of the detailed finding.
evaluation
enum
The evaluation of the finding.
Allowed enum values: pass,fail
evaluation_changed_at
int64
The date on which the evaluation for this finding changed (Unix ms).
message
string
The remediation message for this finding.
mute
object
Information about the mute status of this finding.
description
string
Additional information about the reason why this finding is muted or unmuted.
expiration_date
int64
The expiration date of the mute or unmute action (Unix ms).
muted
boolean
Whether this finding is muted or unmuted.
reason
enum
The reason why this finding is muted or unmuted.
Allowed enum values: PENDING_FIX,FALSE_POSITIVE,ACCEPTED_RISK,NO_PENDING_FIX,HUMAN_ERROR,NO_LONGER_ACCEPTED_RISK,OTHER
start_date
int64
The start of the mute period.
uuid
string
The ID of the user who muted or unmuted this finding.
resource
string
The resource name of this finding.
resource_configuration
object
The resource configuration for this finding.
resource_discovery_date
int64
The date on which the resource was discovered (Unix ms).
resource_type
string
The resource type of this finding.
rule
object
The rule that triggered this finding.
id
string
The ID of the rule that triggered this finding.
name
string
The name of the rule that triggered this finding.
status
enum
The status of the finding.
Allowed enum values: critical,high,medium,low,info
tags
[string]
The tags associated with this finding.
id
string
The unique ID for this finding.
type
enum
The JSON:API type for findings that have the message and resource configuration.
Allowed enum values: detailed_finding
default: detailed_finding
{"data":{"attributes":{"evaluation":"pass","evaluation_changed_at":1678721573794,"message":"## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data.","mute":{"description":"To be resolved later","expiration_date":1778721573794,"muted":true,"reason":"ACCEPTED_RISK","start_date":1678721573794,"uuid":"e51c9744-d158-11ec-ad23-da7ad0900002"},"resource":"my_resource_name","resource_configuration":{},"resource_discovery_date":1678721573794,"resource_type":"azure_storage_account","rule":{"id":"dv2-jzf-41i","name":"Soft delete is enabled for Azure Storage"},"status":"critical","tags":["cloud_provider:aws","myTag:myValue"]},"id":"ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==","type":"detailed_finding"}}
Bad Request: The server cannot process the request due to invalid syntax in the request.
"""
Get a finding returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApiconfiguration=Configuration()configuration.unstable_operations["get_finding"]=TruewithApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.get_finding(finding_id="AgAAAYd59gjghzF52gAAAAAAAAAYAAAAAEFZZDU5Z2pnQUFCRTRvV1lFeEo4SlFBQQAAACQAAAAAMDE4NzdhMDEtMDRiYS00NTZlLWFmMzMtNTIxNmNkNjVlNDMz",)print(response)
# Get a finding returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.get_finding".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newpapi_instance.get_finding("AgAAAYd59gjghzF52gAAAAAAAAAYAAAAAEFZZDU5Z2pnQUFCRTRvV1lFeEo4SlFBQQAAACQAAAAAMDE4NzdhMDEtMDRiYS00NTZlLWFmMzMtNTIxNmNkNjVlNDMz")
// Get a finding returns "OK" response
packagemainimport("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.GetFinding",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.GetFinding(ctx,"AgAAAYd59gjghzF52gAAAAAAAAAYAAAAAEFZZDU5Z2pnQUFCRTRvV1lFeEo4SlFBQQAAACQAAAAAMDE4NzdhMDEtMDRiYS00NTZlLWFmMzMtNTIxNmNkNjVlNDMz",*datadogV2.NewGetFindingOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.GetFinding`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.GetFinding`:\n%s\n",responseContent)}
// Get a finding returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.GetFindingResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.getFinding",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);try{GetFindingResponseresult=apiInstance.getFinding("AgAAAYd59gjghzF52gAAAAAAAAAYAAAAAEFZZDU5Z2pnQUFCRTRvV1lFeEo4SlFBQQAAACQAAAAAMDE4NzdhMDEtMDRiYS00NTZlLWFmMzMtNTIxNmNkNjVlNDMz");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#getFinding");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a finding returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::GetFindingOptionalParams;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetFinding",true);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.get_finding("AgAAAYd59gjghzF52gAAAAAAAAAYAAAAAEFZZDU5Z2pnQUFCRTRvV1lFeEo4SlFBQQAAACQAAAAAMDE4NzdhMDEtMDRiYS00NTZlLWFmMzMtNTIxNmNkNjVlNDMz".to_string(),GetFindingOptionalParams::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.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a finding returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getFinding"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);constparams: v2.SecurityMonitoringApiGetFindingRequest={findingId:"AgAAAYd59gjghzF52gAAAAAAAAAYAAAAAEFZZDU5Z2pnQUFCRTRvV1lFeEo4SlFBQQAAACQAAAAAMDE4NzdhMDEtMDRiYS00NTZlLWFmMzMtNTIxNmNkNjVlNDMz",};apiInstance.getFinding(params).then((data: v2.GetFindingResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
All findings are updated with the same attributes. The request body must include at least two attributes: muted and reason.
The allowed reasons depend on whether the finding is being muted or unmuted:
To mute a finding: PENDING_FIX, FALSE_POSITIVE, ACCEPTED_RISK, OTHER.
To unmute a finding : NO_PENDING_FIX, HUMAN_ERROR, NO_LONGER_ACCEPTED_RISK, OTHER.
Meta
The request body must include a list of the finding IDs to be updated.
Data object containing the new bulk mute properties of the finding.
attributes [required]
object
The mute properties to be updated.
mute [required]
object
Object containing the new mute properties of the findings.
description
string
Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.
expiration_date
int64
The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.
If this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.
muted [required]
boolean
Whether those findings should be muted or unmuted.
reason [required]
enum
The reason why this finding is muted or unmuted.
Allowed enum values: PENDING_FIX,FALSE_POSITIVE,ACCEPTED_RISK,NO_PENDING_FIX,HUMAN_ERROR,NO_LONGER_ACCEPTED_RISK,OTHER
id [required]
string
UUID to identify the request
meta [required]
object
Meta object containing the findings to be updated.
findings
[object]
Array of findings.
finding_id
string
The unique ID for this finding.
type [required]
enum
The JSON:API type for findings.
Allowed enum values: finding
// Mute or unmute a batch of findings returns "OK" response
packagemainimport("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(){body:=datadogV2.BulkMuteFindingsRequest{Data:datadogV2.BulkMuteFindingsRequestData{Attributes:datadogV2.BulkMuteFindingsRequestAttributes{Mute:datadogV2.BulkMuteFindingsRequestProperties{ExpirationDate:datadog.PtrInt64(1778721573794),Muted:true,Reason:datadogV2.FINDINGMUTEREASON_ACCEPTED_RISK,},},Id:"dbe5f567-192b-4404-b908-29b70e1c9f76",Meta:datadogV2.BulkMuteFindingsRequestMeta{Findings:[]datadogV2.BulkMuteFindingsRequestMetaFindings{{FindingId:datadog.PtrString("ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw=="),},},},Type:datadogV2.FINDINGTYPE_FINDING,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.MuteFindings",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.MuteFindings(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.MuteFindings`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.MuteFindings`:\n%s\n",responseContent)}
// Mute or unmute a batch of findings returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.BulkMuteFindingsRequest;importcom.datadog.api.client.v2.model.BulkMuteFindingsRequestAttributes;importcom.datadog.api.client.v2.model.BulkMuteFindingsRequestData;importcom.datadog.api.client.v2.model.BulkMuteFindingsRequestMeta;importcom.datadog.api.client.v2.model.BulkMuteFindingsRequestMetaFindings;importcom.datadog.api.client.v2.model.BulkMuteFindingsRequestProperties;importcom.datadog.api.client.v2.model.BulkMuteFindingsResponse;importcom.datadog.api.client.v2.model.FindingMuteReason;importcom.datadog.api.client.v2.model.FindingType;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.muteFindings",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);BulkMuteFindingsRequestbody=newBulkMuteFindingsRequest().data(newBulkMuteFindingsRequestData().attributes(newBulkMuteFindingsRequestAttributes().mute(newBulkMuteFindingsRequestProperties().expirationDate(1778721573794L).muted(true).reason(FindingMuteReason.ACCEPTED_RISK))).id("dbe5f567-192b-4404-b908-29b70e1c9f76").meta(newBulkMuteFindingsRequestMeta().findings(Collections.singletonList(newBulkMuteFindingsRequestMetaFindings().findingId("ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==")))).type(FindingType.FINDING));try{BulkMuteFindingsResponseresult=apiInstance.muteFindings(body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#muteFindings");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Mute or unmute a batch of findings returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApifromdatadog_api_client.v2.model.bulk_mute_findings_requestimportBulkMuteFindingsRequestfromdatadog_api_client.v2.model.bulk_mute_findings_request_attributesimportBulkMuteFindingsRequestAttributesfromdatadog_api_client.v2.model.bulk_mute_findings_request_dataimportBulkMuteFindingsRequestDatafromdatadog_api_client.v2.model.bulk_mute_findings_request_metaimportBulkMuteFindingsRequestMetafromdatadog_api_client.v2.model.bulk_mute_findings_request_meta_findingsimportBulkMuteFindingsRequestMetaFindingsfromdatadog_api_client.v2.model.bulk_mute_findings_request_propertiesimportBulkMuteFindingsRequestPropertiesfromdatadog_api_client.v2.model.finding_mute_reasonimportFindingMuteReasonfromdatadog_api_client.v2.model.finding_typeimportFindingTypebody=BulkMuteFindingsRequest(data=BulkMuteFindingsRequestData(attributes=BulkMuteFindingsRequestAttributes(mute=BulkMuteFindingsRequestProperties(expiration_date=1778721573794,muted=True,reason=FindingMuteReason.ACCEPTED_RISK,),),id="dbe5f567-192b-4404-b908-29b70e1c9f76",meta=BulkMuteFindingsRequestMeta(findings=[BulkMuteFindingsRequestMetaFindings(finding_id="ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==",),],),type=FindingType.FINDING,),)configuration=Configuration()configuration.unstable_operations["mute_findings"]=TruewithApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.mute_findings(body=body)print(response)
# Mute or unmute a batch of findings returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.mute_findings".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newbody=DatadogAPIClient::V2::BulkMuteFindingsRequest.new({data:DatadogAPIClient::V2::BulkMuteFindingsRequestData.new({attributes:DatadogAPIClient::V2::BulkMuteFindingsRequestAttributes.new({mute:DatadogAPIClient::V2::BulkMuteFindingsRequestProperties.new({expiration_date:1778721573794,muted:true,reason:DatadogAPIClient::V2::FindingMuteReason::ACCEPTED_RISK,}),}),id:"dbe5f567-192b-4404-b908-29b70e1c9f76",meta:DatadogAPIClient::V2::BulkMuteFindingsRequestMeta.new({findings:[DatadogAPIClient::V2::BulkMuteFindingsRequestMetaFindings.new({finding_id:"ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==",}),],}),type:DatadogAPIClient::V2::FindingType::FINDING,}),})papi_instance.mute_findings(body)
// Mute or unmute a batch of findings returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;usedatadog_api_client::datadogV2::model::BulkMuteFindingsRequest;usedatadog_api_client::datadogV2::model::BulkMuteFindingsRequestAttributes;usedatadog_api_client::datadogV2::model::BulkMuteFindingsRequestData;usedatadog_api_client::datadogV2::model::BulkMuteFindingsRequestMeta;usedatadog_api_client::datadogV2::model::BulkMuteFindingsRequestMetaFindings;usedatadog_api_client::datadogV2::model::BulkMuteFindingsRequestProperties;usedatadog_api_client::datadogV2::model::FindingMuteReason;usedatadog_api_client::datadogV2::model::FindingType;#[tokio::main]asyncfnmain(){letbody=BulkMuteFindingsRequest::new(BulkMuteFindingsRequestData::new(BulkMuteFindingsRequestAttributes::new(BulkMuteFindingsRequestProperties::new(true,FindingMuteReason::ACCEPTED_RISK).expiration_date(1778721573794),),"dbe5f567-192b-4404-b908-29b70e1c9f76".to_string(),BulkMuteFindingsRequestMeta::new().findings(vec![BulkMuteFindingsRequestMetaFindings::new().finding_id("ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==".to_string(),)]),FindingType::FINDING,));letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.MuteFindings",true);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.mute_findings(body).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.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Mute or unmute a batch of findings returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.muteFindings"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);constparams: v2.SecurityMonitoringApiMuteFindingsRequest={body:{data:{attributes:{mute:{expirationDate: 1778721573794,muted: true,reason:"ACCEPTED_RISK",},},id:"dbe5f567-192b-4404-b908-29b70e1c9f76",meta:{findings:[{findingId:"ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==",},],},type:"finding",},},};apiInstance.muteFindings(params).then((data: v2.BulkMuteFindingsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Add a security signal to an incident. This makes it possible to search for signals by incident within the signal explorer and to view the signals on the incident timeline.
This endpoint requires the security_monitoring_signals_write permission.
// Add a security signal to an incident returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){body:=datadogV1.AddSignalToIncidentRequest{IncidentId:2609,}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.AddSecurityMonitoringSignalToIncident(ctx,"AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.AddSecurityMonitoringSignalToIncident`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.AddSecurityMonitoringSignalToIncident`:\n%s\n",responseContent)}
// Add a security signal to an incident returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.SecurityMonitoringApi;importcom.datadog.api.client.v1.model.AddSignalToIncidentRequest;importcom.datadog.api.client.v1.model.SuccessfulSignalUpdateResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);AddSignalToIncidentRequestbody=newAddSignalToIncidentRequest().incidentId(2609L);try{SuccessfulSignalUpdateResponseresult=apiInstance.addSecurityMonitoringSignalToIncident("AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#addSecurityMonitoringSignalToIncident");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Add a security signal to an incident returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.security_monitoring_apiimportSecurityMonitoringApifromdatadog_api_client.v1.model.add_signal_to_incident_requestimportAddSignalToIncidentRequestbody=AddSignalToIncidentRequest(incident_id=2609,)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.add_security_monitoring_signal_to_incident(signal_id="AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body=body)print(response)
# Add a security signal to an incident returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::SecurityMonitoringAPI.newbody=DatadogAPIClient::V1::AddSignalToIncidentRequest.new({incident_id:2609,})papi_instance.add_security_monitoring_signal_to_incident("AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body)
// Add a security signal to an incident returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_security_monitoring::SecurityMonitoringAPI;usedatadog_api_client::datadogV1::model::AddSignalToIncidentRequest;#[tokio::main]asyncfnmain(){letbody=AddSignalToIncidentRequest::new(2609);letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.add_security_monitoring_signal_to_incident("AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE".to_string(),body,).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.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Add a security signal to an incident returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.SecurityMonitoringApi(configuration);constparams: v1.SecurityMonitoringApiAddSecurityMonitoringSignalToIncidentRequest={body:{incidentId: 2609,},signalId:"AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",};apiInstance.addSecurityMonitoringSignalToIncident(params).then((data: v1.SuccessfulSignalUpdateResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Optional comment to explain why a signal is being archived.
archiveReason
enum
Reason why a signal has been archived.
Allowed enum values: none,false_positive,testing_or_maintenance,investigated_case_opened,true_positive_benign,true_positive_malicious,other
state [required]
enum
The new triage state of the signal.
Allowed enum values: open,archived,under_review
version
int64
Version of the updated signal. If server side version is higher, update will be rejected.
// Change the triage state of a security signal returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){body:=datadogV1.SignalStateUpdateRequest{ArchiveReason:datadogV1.SIGNALARCHIVEREASON_NONE.Ptr(),State:datadogV1.SIGNALTRIAGESTATE_OPEN,}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.EditSecurityMonitoringSignalState(ctx,"AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.EditSecurityMonitoringSignalState`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.EditSecurityMonitoringSignalState`:\n%s\n",responseContent)}
// Change the triage state of a security signal returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.SecurityMonitoringApi;importcom.datadog.api.client.v1.model.SignalArchiveReason;importcom.datadog.api.client.v1.model.SignalStateUpdateRequest;importcom.datadog.api.client.v1.model.SignalTriageState;importcom.datadog.api.client.v1.model.SuccessfulSignalUpdateResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);SignalStateUpdateRequestbody=newSignalStateUpdateRequest().archiveReason(SignalArchiveReason.NONE).state(SignalTriageState.OPEN);try{SuccessfulSignalUpdateResponseresult=apiInstance.editSecurityMonitoringSignalState("AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#editSecurityMonitoringSignalState");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Change the triage state of a security signal returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.security_monitoring_apiimportSecurityMonitoringApifromdatadog_api_client.v1.model.signal_archive_reasonimportSignalArchiveReasonfromdatadog_api_client.v1.model.signal_state_update_requestimportSignalStateUpdateRequestfromdatadog_api_client.v1.model.signal_triage_stateimportSignalTriageStatebody=SignalStateUpdateRequest(archive_reason=SignalArchiveReason.NONE,state=SignalTriageState.OPEN,)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.edit_security_monitoring_signal_state(signal_id="AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body=body)print(response)
# Change the triage state of a security signal returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::SecurityMonitoringAPI.newbody=DatadogAPIClient::V1::SignalStateUpdateRequest.new({archive_reason:DatadogAPIClient::V1::SignalArchiveReason::NONE,state:DatadogAPIClient::V1::SignalTriageState::OPEN,})papi_instance.edit_security_monitoring_signal_state("AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",body)
// Change the triage state of a security signal returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_security_monitoring::SecurityMonitoringAPI;usedatadog_api_client::datadogV1::model::SignalArchiveReason;usedatadog_api_client::datadogV1::model::SignalStateUpdateRequest;usedatadog_api_client::datadogV1::model::SignalTriageState;#[tokio::main]asyncfnmain(){letbody=SignalStateUpdateRequest::new(SignalTriageState::OPEN).archive_reason(SignalArchiveReason::NONE);letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.edit_security_monitoring_signal_state("AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE".to_string(),body,).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.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Change the triage state of a security signal returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.SecurityMonitoringApi(configuration);constparams: v1.SecurityMonitoringApiEditSecurityMonitoringSignalStateRequest={body:{archiveReason:"none",state:"open",},signalId:"AQAAAYDiB_Ol8PbzFAAAAABBWURpQl9PbEFBQU0yeXhGTG9ZV2JnQUE",};apiInstance.editSecurityMonitoringSignalState(params).then((data: v1.SuccessfulSignalUpdateResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
// Change the triage state of a security signal returns "OK" response
packagemainimport("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(){body:=datadogV2.SecurityMonitoringSignalStateUpdateRequest{Data:datadogV2.SecurityMonitoringSignalStateUpdateData{Attributes:datadogV2.SecurityMonitoringSignalStateUpdateAttributes{ArchiveReason:datadogV2.SECURITYMONITORINGSIGNALARCHIVEREASON_NONE.Ptr(),State:datadogV2.SECURITYMONITORINGSIGNALSTATE_OPEN,},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.EditSecurityMonitoringSignalState(ctx,"AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE",body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.EditSecurityMonitoringSignalState`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.EditSecurityMonitoringSignalState`:\n%s\n",responseContent)}
// Change the triage state of a security signal returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.SecurityMonitoringSignalArchiveReason;importcom.datadog.api.client.v2.model.SecurityMonitoringSignalState;importcom.datadog.api.client.v2.model.SecurityMonitoringSignalStateUpdateAttributes;importcom.datadog.api.client.v2.model.SecurityMonitoringSignalStateUpdateData;importcom.datadog.api.client.v2.model.SecurityMonitoringSignalStateUpdateRequest;importcom.datadog.api.client.v2.model.SecurityMonitoringSignalTriageUpdateResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);SecurityMonitoringSignalStateUpdateRequestbody=newSecurityMonitoringSignalStateUpdateRequest().data(newSecurityMonitoringSignalStateUpdateData().attributes(newSecurityMonitoringSignalStateUpdateAttributes().archiveReason(SecurityMonitoringSignalArchiveReason.NONE).state(SecurityMonitoringSignalState.OPEN)));try{SecurityMonitoringSignalTriageUpdateResponseresult=apiInstance.editSecurityMonitoringSignalState("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE",body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#editSecurityMonitoringSignalState");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Change the triage state of a security signal returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApifromdatadog_api_client.v2.model.security_monitoring_signal_archive_reasonimportSecurityMonitoringSignalArchiveReasonfromdatadog_api_client.v2.model.security_monitoring_signal_stateimportSecurityMonitoringSignalStatefromdatadog_api_client.v2.model.security_monitoring_signal_state_update_attributesimport(SecurityMonitoringSignalStateUpdateAttributes,)fromdatadog_api_client.v2.model.security_monitoring_signal_state_update_dataimport(SecurityMonitoringSignalStateUpdateData,)fromdatadog_api_client.v2.model.security_monitoring_signal_state_update_requestimport(SecurityMonitoringSignalStateUpdateRequest,)body=SecurityMonitoringSignalStateUpdateRequest(data=SecurityMonitoringSignalStateUpdateData(attributes=SecurityMonitoringSignalStateUpdateAttributes(archive_reason=SecurityMonitoringSignalArchiveReason.NONE,state=SecurityMonitoringSignalState.OPEN,),),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.edit_security_monitoring_signal_state(signal_id="AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE",body=body)print(response)
# Change the triage state of a security signal returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newbody=DatadogAPIClient::V2::SecurityMonitoringSignalStateUpdateRequest.new({data:DatadogAPIClient::V2::SecurityMonitoringSignalStateUpdateData.new({attributes:DatadogAPIClient::V2::SecurityMonitoringSignalStateUpdateAttributes.new({archive_reason:DatadogAPIClient::V2::SecurityMonitoringSignalArchiveReason::NONE,state:DatadogAPIClient::V2::SecurityMonitoringSignalState::OPEN,}),}),})papi_instance.edit_security_monitoring_signal_state("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE",body)
// Change the triage state of a security signal returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;usedatadog_api_client::datadogV2::model::SecurityMonitoringSignalArchiveReason;usedatadog_api_client::datadogV2::model::SecurityMonitoringSignalState;usedatadog_api_client::datadogV2::model::SecurityMonitoringSignalStateUpdateAttributes;usedatadog_api_client::datadogV2::model::SecurityMonitoringSignalStateUpdateData;usedatadog_api_client::datadogV2::model::SecurityMonitoringSignalStateUpdateRequest;#[tokio::main]asyncfnmain(){letbody=SecurityMonitoringSignalStateUpdateRequest::new(SecurityMonitoringSignalStateUpdateData::new(SecurityMonitoringSignalStateUpdateAttributes::new(SecurityMonitoringSignalState::OPEN).archive_reason(SecurityMonitoringSignalArchiveReason::NONE),),);letconfiguration=datadog::Configuration::new();letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.edit_security_monitoring_signal_state("AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE".to_string(),body,).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.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Change the triage state of a security signal returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SecurityMonitoringApi(configuration);constparams: v2.SecurityMonitoringApiEditSecurityMonitoringSignalStateRequest={body:{data:{attributes:{archiveReason:"none",state:"open",},},},signalId:"AQAAAYG1bl5K4HuUewAAAABBWUcxYmw1S0FBQmt2RmhRN0V4ZUVnQUE",};apiInstance.editSecurityMonitoringSignalState(params).then((data: v2.SecurityMonitoringSignalTriageUpdateResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));