The data object for a severity modifier rule as returned by the API.
attributes [required]
object
Attributes of a severity modifier rule as returned by the API.
action [required]
<oneOf>
The action to take when a severity modifier rule matches a finding. This is a discriminated union on type: set assigns a fixed severity, while shift moves the severity up or down by one rank.
A severity modifier rule's rule.query must not filter on @severity or on the @severity_details.user_adjusted.* namespace.
Use @severity_details.adjusted.value instead, which reflects the severity before user-defined adjustments.
<type=set>
object
Sets matched findings to a fixed severity.
description
string
An optional free-form explanation for the severity change.
severity [required]
enum
The severity to assign to matched findings. info_none is not supported for the iac_misconfiguration, runtime_code_vulnerability, secret, or static_code_vulnerability finding types.
Allowed enum values: info_none,low,medium,high,critical
type [required]
enum
The type of a severity modifier rule action that sets a fixed severity.
Allowed enum values: set
<type=shift>
object
Shifts matched findings up or down by one severity rank.
description
string
An optional free-form explanation for the severity change.
severity_delta [required]
enum
The direction in which to shift the severity of matched findings by one rank.
Allowed enum values: up_one,down_one
type [required]
enum
The type of a severity modifier rule action that shifts the severity by one rank.
Allowed enum values: shift
created_at [required]
int64
The Unix timestamp in milliseconds when the rule was created.
created_by [required]
object
The user or Datadog system who created the rule.
id [required]
string
The actor's identifier (a user UUID or a system identifier).
name [required]
string
The name of the actor.
type [required]
enum
Whether the actor is a user or the Datadog system.
Allowed enum values: user,system
enabled [required]
boolean
Whether the severity modifier rule is enabled.
modified_at [required]
int64
The Unix timestamp in milliseconds when the rule was last modified.
modified_by [required]
object
The user or Datadog system who last modified the rule.
id [required]
string
The actor's identifier (a user UUID or a system identifier).
name [required]
string
The name of the actor.
type [required]
enum
Whether the actor is a user or the Datadog system.
Allowed enum values: user,system
name [required]
string
The name of the severity modifier rule.
rule [required]
object
Defines the scope of findings to which the automation rule applies.
finding_types [required]
[string]
The list of security finding types that the automation rule applies to.
query
string
A search query to further filter the findings matched by this rule. The @workflow.* namespace and @status fields are not permitted. For a reference of available fields, see the Security Findings schema documentation.
id [required]
uuid
The ID of the severity modifier rule.
type [required]
enum
The JSON:API type for severity modifier rules.
Allowed enum values: severity_modifier_rules
{"data":{"attributes":{"action":{"description":"Lower severity for dev environment noise","severity":"low","type":"set"},"created_at":1722439510282,"created_by":{"id":"00000000-0000-0000-0000-000000000000","name":"Jane Doe","type":"user"},"enabled":true,"modified_at":1722439510282,"modified_by":{"id":"00000000-0000-0000-0000-000000000000","name":"Jane Doe","type":"user"},"name":"Downgrade misconfigurations in dev","rule":{"finding_types":["misconfiguration"],"query":"env:prod team:platform"}},"id":"00000000-0000-0000-0000-000000000000","type":"severity_modifier_rules"}}
"""
Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.security_monitoring_apiimportSecurityMonitoringApi# there is a valid "valid_severity_modifier_rule" in the systemVALID_SEVERITY_MODIFIER_RULE_DATA_ID=environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]configuration=Configuration()configuration.unstable_operations["get_security_findings_automation_severity_modifier_rule"]=TruewithApiClient(configuration)asapi_client:api_instance=SecurityMonitoringApi(api_client)response=api_instance.get_security_findings_automation_severity_modifier_rule(rule_id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,)print(response)
# Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.get_security_findings_automation_severity_modifier_rule".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.new# there is a valid "valid_severity_modifier_rule" in the systemVALID_SEVERITY_MODIFIER_RULE_DATA_ID=ENV["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]papi_instance.get_security_findings_automation_severity_modifier_rule(VALID_SEVERITY_MODIFIER_RULE_DATA_ID)
// Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2""github.com/google/uuid")funcmain(){// there is a valid "valid_severity_modifier_rule" in the systemValidSeverityModifierRuleDataID:=uuid.MustParse(os.Getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"))ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetSecurityFindingsAutomationSeverityModifierRule",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.GetSecurityFindingsAutomationSeverityModifierRule(ctx,ValidSeverityModifierRuleDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.GetSecurityFindingsAutomationSeverityModifierRule`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.GetSecurityFindingsAutomationSeverityModifierRule`:\n%s\n",responseContent)}
// Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.SeverityModifierRuleResponse;importjava.util.UUID;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.getSecurityFindingsAutomationSeverityModifierRule",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);// there is a valid "valid_severity_modifier_rule" in the systemUUIDVALID_SEVERITY_MODIFIER_RULE_DATA_ID=null;try{VALID_SEVERITY_MODIFIER_RULE_DATA_ID=UUID.fromString(System.getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"));}catch(IllegalArgumentExceptione){System.err.println("Error parsing UUID: "+e.getMessage());}try{SeverityModifierRuleResponseresult=apiInstance.getSecurityFindingsAutomationSeverityModifierRule(VALID_SEVERITY_MODIFIER_RULE_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling"+" SecurityMonitoringApi#getSecurityFindingsAutomationSeverityModifierRule");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a severity modifier rule returns "Successfully retrieved the severity
// modifier rule" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){// there is a valid "valid_severity_modifier_rule" in the system
letvalid_severity_modifier_rule_data_id=uuid::Uuid::parse_str(&std::env::var("VALID_SEVERITY_MODIFIER_RULE_DATA_ID").unwrap()).expect("Invalid UUID");letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetSecurityFindingsAutomationSeverityModifierRule",true,);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.get_security_findings_automation_severity_modifier_rule(valid_severity_modifier_rule_data_id.clone(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a severity modifier rule returns "Successfully retrieved the severity modifier rule" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getSecurityFindingsAutomationSeverityModifierRule"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);// there is a valid "valid_severity_modifier_rule" in the system
constVALID_SEVERITY_MODIFIER_RULE_DATA_ID=process.env.VALID_SEVERITY_MODIFIER_RULE_DATA_IDasstring;constparams: v2.SecurityMonitoringApiGetSecurityFindingsAutomationSeverityModifierRuleRequest={ruleId: VALID_SEVERITY_MODIFIER_RULE_DATA_ID,};apiInstance.getSecurityFindingsAutomationSeverityModifierRule(params).then((data: v2.SeverityModifierRuleResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));