Update a severity modifier rule
WARNINGNote: This endpoint is in Preview and is subject to change.
If you have any feedback, contact Datadog support.
PUT
https://api.datadoghq.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.us3.datadoghq.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.us5.datadoghq.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.datadoghq.eu/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.ap1.datadoghq.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.ap2.datadoghq.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.uk1.datadoghq.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.ddog-gov.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}https://api.us2.ddog-gov.com/api/v2/security/findings/automation/severity_modifier_rules/{rule_id}Présentation
Update a severity modifier rule by ID.
Arguments
Paramètres du chemin
Name
Type
Description
rule_id [required]string
The ID of the severity modifier rule.
Requête
Body Data (required)
Champ
Type
Description
data [required]object
The data object for a severity modifier rule update request. The id must match the rule_id path parameter.
attributes [required]object
Attributes for creating or updating a severity modifier rule.
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.
descriptionstring
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, criticaltype [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.
descriptionstring
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_onetype [required]enum
The type of a severity modifier rule action that shifts the severity by one rank.
Allowed enum values:
shiftenabledboolean
Whether the severity modifier rule is enabled.
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.
querystring
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 to update.
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"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}Réponse
Successfully updated the severity modifier rule
A single severity modifier rule response.
Champ
Type
Description
data [required]object
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.
descriptionstring
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, criticaltype [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.
descriptionstring
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_onetype [required]enum
The type of a severity modifier rule action that shifts the severity by one rank.
Allowed enum values:
shiftcreated_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, systemenabled [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, systemname [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.
querystring
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"
}
}Bad Request
API error response.
Champ
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Forbidden
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Unprocessable Entity
API error response.
Champ
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Exemple de code
Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOF# Path parameters
export rule_id="00000000-0000-0000-0000-000000000000"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PUT "https://api.${DD_SITE}/api/v2/security/findings/automation/severity_modifier_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"description": "Lower severity for dev environment noise",
"severity": "low",
"type": "set"
},
"enabled": true,
"name": "Downgrade misconfigurations in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "severity_modifier_rules"
}
}
EOFUpdate a severity modifier rule returns "Successfully updated the severity modifier rule" response
// Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
package main
import (
"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"
)
func main() {
// there is a valid "valid_severity_modifier_rule" in the system
ValidSeverityModifierRuleDataID := uuid.MustParse(os.Getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"))
body := datadogV2.SeverityModifierRuleUpdateRequest{
Data: datadogV2.SeverityModifierRuleDataUpdate{
Attributes: datadogV2.SeverityModifierRuleAttributesCreate{
Action: datadogV2.SeverityModifierRuleAction{
SeverityModifierRuleSetAction: &datadogV2.SeverityModifierRuleSetAction{
Description: datadog.PtrString("Lower severity for dev environment noise"),
Severity: datadogV2.SEVERITYMODIFIERSEVERITY_LOW,
Type: datadogV2.SEVERITYMODIFIERRULESETACTIONTYPE_SET,
}},
Enabled: datadog.PtrBool(true),
Name: "Downgrade misconfigurations in dev",
Rule: datadogV2.AutomationRuleScope{
FindingTypes: []datadogV2.SecurityFindingType{
datadogV2.SECURITYFINDINGTYPE_MISCONFIGURATION,
},
Query: datadog.PtrString("env:prod team:platform"),
},
},
Id: ValidSeverityModifierRuleDataID,
Type: datadogV2.SEVERITYMODIFIERRULETYPE_SEVERITY_MODIFIER_RULES,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.UpdateSecurityFindingsAutomationSeverityModifierRule", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewSecurityMonitoringApi(apiClient)
resp, r, err := api.UpdateSecurityFindingsAutomationSeverityModifierRule(ctx, ValidSeverityModifierRuleDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.UpdateSecurityFindingsAutomationSeverityModifierRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.UpdateSecurityFindingsAutomationSeverityModifierRule`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
// Update a severity modifier rule returns "Successfully updated the severity modifier rule"
// response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.AutomationRuleScope;
import com.datadog.api.client.v2.model.SecurityFindingType;
import com.datadog.api.client.v2.model.SeverityModifierRuleAction;
import com.datadog.api.client.v2.model.SeverityModifierRuleAttributesCreate;
import com.datadog.api.client.v2.model.SeverityModifierRuleDataUpdate;
import com.datadog.api.client.v2.model.SeverityModifierRuleResponse;
import com.datadog.api.client.v2.model.SeverityModifierRuleSetAction;
import com.datadog.api.client.v2.model.SeverityModifierRuleSetActionType;
import com.datadog.api.client.v2.model.SeverityModifierRuleType;
import com.datadog.api.client.v2.model.SeverityModifierRuleUpdateRequest;
import com.datadog.api.client.v2.model.SeverityModifierSeverity;
import java.util.Collections;
import java.util.UUID;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled(
"v2.updateSecurityFindingsAutomationSeverityModifierRule", true);
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
// there is a valid "valid_severity_modifier_rule" in the system
UUID VALID_SEVERITY_MODIFIER_RULE_DATA_ID = null;
try {
VALID_SEVERITY_MODIFIER_RULE_DATA_ID =
UUID.fromString(System.getenv("VALID_SEVERITY_MODIFIER_RULE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
SeverityModifierRuleUpdateRequest body =
new SeverityModifierRuleUpdateRequest()
.data(
new SeverityModifierRuleDataUpdate()
.attributes(
new SeverityModifierRuleAttributesCreate()
.action(
new SeverityModifierRuleAction(
new SeverityModifierRuleSetAction()
.description("Lower severity for dev environment noise")
.severity(SeverityModifierSeverity.LOW)
.type(SeverityModifierRuleSetActionType.SET)))
.enabled(true)
.name("Downgrade misconfigurations in dev")
.rule(
new AutomationRuleScope()
.findingTypes(
Collections.singletonList(
SecurityFindingType.MISCONFIGURATION))
.query("env:prod team:platform")))
.id(VALID_SEVERITY_MODIFIER_RULE_DATA_ID)
.type(SeverityModifierRuleType.SEVERITY_MODIFIER_RULES));
try {
SeverityModifierRuleResponse result =
apiInstance.updateSecurityFindingsAutomationSeverityModifierRule(
VALID_SEVERITY_MODIFIER_RULE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#updateSecurityFindingsAutomationSeverityModifierRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
"""
Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.automation_rule_scope import AutomationRuleScope
from datadog_api_client.v2.model.security_finding_type import SecurityFindingType
from datadog_api_client.v2.model.severity_modifier_rule_attributes_create import SeverityModifierRuleAttributesCreate
from datadog_api_client.v2.model.severity_modifier_rule_data_update import SeverityModifierRuleDataUpdate
from datadog_api_client.v2.model.severity_modifier_rule_set_action import SeverityModifierRuleSetAction
from datadog_api_client.v2.model.severity_modifier_rule_set_action_type import SeverityModifierRuleSetActionType
from datadog_api_client.v2.model.severity_modifier_rule_type import SeverityModifierRuleType
from datadog_api_client.v2.model.severity_modifier_rule_update_request import SeverityModifierRuleUpdateRequest
from datadog_api_client.v2.model.severity_modifier_severity import SeverityModifierSeverity
# there is a valid "valid_severity_modifier_rule" in the system
VALID_SEVERITY_MODIFIER_RULE_DATA_ID = environ["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]
body = SeverityModifierRuleUpdateRequest(
data=SeverityModifierRuleDataUpdate(
attributes=SeverityModifierRuleAttributesCreate(
action=SeverityModifierRuleSetAction(
description="Lower severity for dev environment noise",
severity=SeverityModifierSeverity.LOW,
type=SeverityModifierRuleSetActionType.SET,
),
enabled=True,
name="Downgrade misconfigurations in dev",
rule=AutomationRuleScope(
finding_types=[
SecurityFindingType.MISCONFIGURATION,
],
query="env:prod team:platform",
),
),
id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
type=SeverityModifierRuleType.SEVERITY_MODIFIER_RULES,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["update_security_findings_automation_severity_modifier_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.update_security_findings_automation_severity_modifier_rule(
rule_id=VALID_SEVERITY_MODIFIER_RULE_DATA_ID, body=body
)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
# Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.update_security_findings_automation_severity_modifier_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
# there is a valid "valid_severity_modifier_rule" in the system
VALID_SEVERITY_MODIFIER_RULE_DATA_ID = ENV["VALID_SEVERITY_MODIFIER_RULE_DATA_ID"]
body = DatadogAPIClient::V2::SeverityModifierRuleUpdateRequest.new({
data: DatadogAPIClient::V2::SeverityModifierRuleDataUpdate.new({
attributes: DatadogAPIClient::V2::SeverityModifierRuleAttributesCreate.new({
action: DatadogAPIClient::V2::SeverityModifierRuleSetAction.new({
description: "Lower severity for dev environment noise",
severity: DatadogAPIClient::V2::SeverityModifierSeverity::LOW,
type: DatadogAPIClient::V2::SeverityModifierRuleSetActionType::SET,
}),
enabled: true,
name: "Downgrade misconfigurations in dev",
rule: DatadogAPIClient::V2::AutomationRuleScope.new({
finding_types: [
DatadogAPIClient::V2::SecurityFindingType::MISCONFIGURATION,
],
query: "env:prod team:platform",
}),
}),
id: VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
type: DatadogAPIClient::V2::SeverityModifierRuleType::SEVERITY_MODIFIER_RULES,
}),
})
p api_instance.update_security_findings_automation_severity_modifier_rule(VALID_SEVERITY_MODIFIER_RULE_DATA_ID, body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
// Update a severity modifier rule returns "Successfully updated the severity
// modifier rule" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
use datadog_api_client::datadogV2::model::AutomationRuleScope;
use datadog_api_client::datadogV2::model::SecurityFindingType;
use datadog_api_client::datadogV2::model::SeverityModifierRuleAction;
use datadog_api_client::datadogV2::model::SeverityModifierRuleAttributesCreate;
use datadog_api_client::datadogV2::model::SeverityModifierRuleDataUpdate;
use datadog_api_client::datadogV2::model::SeverityModifierRuleSetAction;
use datadog_api_client::datadogV2::model::SeverityModifierRuleSetActionType;
use datadog_api_client::datadogV2::model::SeverityModifierRuleType;
use datadog_api_client::datadogV2::model::SeverityModifierRuleUpdateRequest;
use datadog_api_client::datadogV2::model::SeverityModifierSeverity;
#[tokio::main]
async fn main() {
// there is a valid "valid_severity_modifier_rule" in the system
let valid_severity_modifier_rule_data_id =
uuid::Uuid::parse_str(&std::env::var("VALID_SEVERITY_MODIFIER_RULE_DATA_ID").unwrap())
.expect("Invalid UUID");
let body = SeverityModifierRuleUpdateRequest::new(SeverityModifierRuleDataUpdate::new(
SeverityModifierRuleAttributesCreate::new(
SeverityModifierRuleAction::SeverityModifierRuleSetAction(Box::new(
SeverityModifierRuleSetAction::new(
SeverityModifierSeverity::LOW,
SeverityModifierRuleSetActionType::SET,
)
.description("Lower severity for dev environment noise".to_string()),
)),
"Downgrade misconfigurations in dev".to_string(),
AutomationRuleScope::new(vec![SecurityFindingType::MISCONFIGURATION])
.query("env:prod team:platform".to_string()),
)
.enabled(true),
valid_severity_modifier_rule_data_id.clone(),
SeverityModifierRuleType::SEVERITY_MODIFIER_RULES,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled(
"v2.update_security_findings_automation_severity_modifier_rule",
true,
);
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api
.update_security_findings_automation_severity_modifier_rule(
valid_severity_modifier_rule_data_id.clone(),
body,
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runUpdate a severity modifier rule returns "Successfully updated the severity modifier rule" response
/**
* Update a severity modifier rule returns "Successfully updated the severity modifier rule" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations[
"v2.updateSecurityFindingsAutomationSeverityModifierRule"
] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);
// there is a valid "valid_severity_modifier_rule" in the system
const VALID_SEVERITY_MODIFIER_RULE_DATA_ID = process.env
.VALID_SEVERITY_MODIFIER_RULE_DATA_ID as string;
const params: v2.SecurityMonitoringApiUpdateSecurityFindingsAutomationSeverityModifierRuleRequest =
{
body: {
data: {
attributes: {
action: {
description: "Lower severity for dev environment noise",
severity: "low",
type: "set",
},
enabled: true,
name: "Downgrade misconfigurations in dev",
rule: {
findingTypes: ["misconfiguration"],
query: "env:prod team:platform",
},
},
type: "severity_modifier_rules",
},
},
ruleId: VALID_SEVERITY_MODIFIER_RULE_DATA_ID,
};
apiInstance
.updateSecurityFindingsAutomationSeverityModifierRule(params)
.then((data: v2.SeverityModifierRuleResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"