Update a mute rule
https://api.datadoghq.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.us3.datadoghq.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.us5.datadoghq.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.datadoghq.eu/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.ap1.datadoghq.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.ap2.datadoghq.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.uk1.datadoghq.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.ddog-gov.com/api/v2/security/findings/automation/mute_rules/{rule_id}https://api.us2.ddog-gov.com/api/v2/security/findings/automation/mute_rules/{rule_id}Overview
Update a mute rule by ID.
Arguments
Path Parameters
rule_id [required]The ID of the mute rule.
Request
Body Data (required)
data [required]The data object for a mute rule update request. The id must match the rule_id path parameter.
attributes [required]Attributes for creating or updating a mute rule.
action [required]The action to take when the mute rule matches a finding.
expire_atThe Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.
reason [required]The reason for muting a security finding.
duplicate, false_positive, no_fix, other, pending_fix, risk_acceptedreason_descriptionAn optional description providing more context for the mute reason.
enabledWhether the mute rule is enabled.
name [required]The name of the mute rule.
rule [required]Defines the scope of findings to which the automation rule applies.
finding_types [required]The list of security finding types that the automation rule applies to.
queryA 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]The ID of the mute rule to update.
type [required]The JSON:API type for mute rules.
mute_rules{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_rules"
}
}Response
Successfully updated the mute rule
A single mute rule response.
data [required]The data object for a mute rule returned by the API.
attributes [required]Attributes of a mute rule returned by the API.
action [required]The action to take when the mute rule matches a finding.
expire_atThe Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.
reason [required]The reason for muting a security finding.
duplicate, false_positive, no_fix, other, pending_fix, risk_acceptedreason_descriptionAn optional description providing more context for the mute reason.
created_at [required]The Unix timestamp in milliseconds when the rule was created.
created_by [required]The user or Datadog system who created the rule.
id [required]The actor's identifier (a user UUID or a system identifier).
name [required]The name of the actor.
type [required]Whether the actor is a user or the Datadog system.
user, systemenabled [required]Whether the mute rule is enabled.
modified_at [required]The Unix timestamp in milliseconds when the rule was last modified.
modified_by [required]The user or Datadog system who last modified the rule.
id [required]The actor's identifier (a user UUID or a system identifier).
name [required]The name of the actor.
type [required]Whether the actor is a user or the Datadog system.
user, systemname [required]The name of the mute rule.
rule [required]Defines the scope of findings to which the automation rule applies.
finding_types [required]The list of security finding types that the automation rule applies to.
queryA 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]The ID of the mute rule.
type [required]The JSON:API type for mute rules.
mute_rules{
"data": {
"attributes": {
"action": {
"expire_at": 4070908800000,
"reason": "risk_accepted",
"reason_description": "Accepted for dev environments only"
},
"created_at": 1722439510282,
"created_by": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Jane Doe",
"type": "user"
},
"enabled": true,
"modified_at": 1722439510282,
"modified_by": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Jane Doe",
"type": "user"
},
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:prod team:platform"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_rules"
}
}Bad Request
API error response.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort 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.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Unprocessable Entity
API error response.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort 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.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# 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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_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/mute_rules/${rule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"action": {
"reason": "risk_accepted"
},
"enabled": false,
"name": "Mute accepted risks in dev",
"rule": {
"finding_types": [
"misconfiguration"
],
"query": "env:dev"
}
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "mute_rules"
}
}
EOF// Update a mute rule returns "Successfully updated the mute 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_mute_rule" in the system
ValidMuteRuleDataID := uuid.MustParse(os.Getenv("VALID_MUTE_RULE_DATA_ID"))
body := datadogV2.MuteRuleUpdateRequest{
Data: datadogV2.MuteRuleDataUpdate{
Attributes: datadogV2.MuteRuleAttributesCreate{
Action: datadogV2.MuteRuleAction{
Reason: datadogV2.MUTEREASON_FALSE_POSITIVE,
},
Enabled: datadog.PtrBool(false),
Name: "Example-Security-Monitoring",
Rule: datadogV2.AutomationRuleScope{
FindingTypes: []datadogV2.SecurityFindingType{
datadogV2.SECURITYFINDINGTYPE_MISCONFIGURATION,
},
Query: datadog.PtrString("env:staging"),
},
},
Id: ValidMuteRuleDataID,
Type: datadogV2.MUTERULETYPE_MUTE_RULES,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.UpdateSecurityFindingsAutomationMuteRule", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewSecurityMonitoringApi(apiClient)
resp, r, err := api.UpdateSecurityFindingsAutomationMuteRule(ctx, ValidMuteRuleDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.UpdateSecurityFindingsAutomationMuteRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.UpdateSecurityFindingsAutomationMuteRule`:\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 mute rule returns "Successfully updated the mute 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.MuteReason;
import com.datadog.api.client.v2.model.MuteRuleAction;
import com.datadog.api.client.v2.model.MuteRuleAttributesCreate;
import com.datadog.api.client.v2.model.MuteRuleDataUpdate;
import com.datadog.api.client.v2.model.MuteRuleResponse;
import com.datadog.api.client.v2.model.MuteRuleType;
import com.datadog.api.client.v2.model.MuteRuleUpdateRequest;
import com.datadog.api.client.v2.model.SecurityFindingType;
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.updateSecurityFindingsAutomationMuteRule", true);
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
// there is a valid "valid_mute_rule" in the system
UUID VALID_MUTE_RULE_DATA_ID = null;
try {
VALID_MUTE_RULE_DATA_ID = UUID.fromString(System.getenv("VALID_MUTE_RULE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
MuteRuleUpdateRequest body =
new MuteRuleUpdateRequest()
.data(
new MuteRuleDataUpdate()
.attributes(
new MuteRuleAttributesCreate()
.action(new MuteRuleAction().reason(MuteReason.FALSE_POSITIVE))
.enabled(false)
.name("Example-Security-Monitoring")
.rule(
new AutomationRuleScope()
.findingTypes(
Collections.singletonList(
SecurityFindingType.MISCONFIGURATION))
.query("env:staging")))
.id(VALID_MUTE_RULE_DATA_ID)
.type(MuteRuleType.MUTE_RULES));
try {
MuteRuleResponse result =
apiInstance.updateSecurityFindingsAutomationMuteRule(VALID_MUTE_RULE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling SecurityMonitoringApi#updateSecurityFindingsAutomationMuteRule");
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 mute rule returns "Successfully updated the mute 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.mute_reason import MuteReason
from datadog_api_client.v2.model.mute_rule_action import MuteRuleAction
from datadog_api_client.v2.model.mute_rule_attributes_create import MuteRuleAttributesCreate
from datadog_api_client.v2.model.mute_rule_data_update import MuteRuleDataUpdate
from datadog_api_client.v2.model.mute_rule_type import MuteRuleType
from datadog_api_client.v2.model.mute_rule_update_request import MuteRuleUpdateRequest
from datadog_api_client.v2.model.security_finding_type import SecurityFindingType
# there is a valid "valid_mute_rule" in the system
VALID_MUTE_RULE_DATA_ID = environ["VALID_MUTE_RULE_DATA_ID"]
body = MuteRuleUpdateRequest(
data=MuteRuleDataUpdate(
attributes=MuteRuleAttributesCreate(
action=MuteRuleAction(
reason=MuteReason.FALSE_POSITIVE,
),
enabled=False,
name="Example-Security-Monitoring",
rule=AutomationRuleScope(
finding_types=[
SecurityFindingType.MISCONFIGURATION,
],
query="env:staging",
),
),
id=VALID_MUTE_RULE_DATA_ID,
type=MuteRuleType.MUTE_RULES,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["update_security_findings_automation_mute_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.update_security_findings_automation_mute_rule(rule_id=VALID_MUTE_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 mute rule returns "Successfully updated the mute 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_mute_rule".to_sym] = true
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
# there is a valid "valid_mute_rule" in the system
VALID_MUTE_RULE_DATA_ID = ENV["VALID_MUTE_RULE_DATA_ID"]
body = DatadogAPIClient::V2::MuteRuleUpdateRequest.new({
data: DatadogAPIClient::V2::MuteRuleDataUpdate.new({
attributes: DatadogAPIClient::V2::MuteRuleAttributesCreate.new({
action: DatadogAPIClient::V2::MuteRuleAction.new({
reason: DatadogAPIClient::V2::MuteReason::FALSE_POSITIVE,
}),
enabled: false,
name: "Example-Security-Monitoring",
rule: DatadogAPIClient::V2::AutomationRuleScope.new({
finding_types: [
DatadogAPIClient::V2::SecurityFindingType::MISCONFIGURATION,
],
query: "env:staging",
}),
}),
id: VALID_MUTE_RULE_DATA_ID,
type: DatadogAPIClient::V2::MuteRuleType::MUTE_RULES,
}),
})
p api_instance.update_security_findings_automation_mute_rule(VALID_MUTE_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 mute rule returns "Successfully updated the mute 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::MuteReason;
use datadog_api_client::datadogV2::model::MuteRuleAction;
use datadog_api_client::datadogV2::model::MuteRuleAttributesCreate;
use datadog_api_client::datadogV2::model::MuteRuleDataUpdate;
use datadog_api_client::datadogV2::model::MuteRuleType;
use datadog_api_client::datadogV2::model::MuteRuleUpdateRequest;
use datadog_api_client::datadogV2::model::SecurityFindingType;
#[tokio::main]
async fn main() {
// there is a valid "valid_mute_rule" in the system
let valid_mute_rule_data_id =
uuid::Uuid::parse_str(&std::env::var("VALID_MUTE_RULE_DATA_ID").unwrap())
.expect("Invalid UUID");
let body = MuteRuleUpdateRequest::new(MuteRuleDataUpdate::new(
MuteRuleAttributesCreate::new(
MuteRuleAction::new(MuteReason::FALSE_POSITIVE),
"Example-Security-Monitoring".to_string(),
AutomationRuleScope::new(vec![SecurityFindingType::MISCONFIGURATION])
.query("env:staging".to_string()),
)
.enabled(false),
valid_mute_rule_data_id.clone(),
MuteRuleType::MUTE_RULES,
));
let mut configuration = datadog::Configuration::new();
configuration
.set_unstable_operation_enabled("v2.update_security_findings_automation_mute_rule", true);
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api
.update_security_findings_automation_mute_rule(valid_mute_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 run/**
* Update a mute rule returns "Successfully updated the mute 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.updateSecurityFindingsAutomationMuteRule"
] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);
// there is a valid "valid_mute_rule" in the system
const VALID_MUTE_RULE_DATA_ID = process.env.VALID_MUTE_RULE_DATA_ID as string;
const params: v2.SecurityMonitoringApiUpdateSecurityFindingsAutomationMuteRuleRequest =
{
body: {
data: {
attributes: {
action: {
reason: "false_positive",
},
enabled: false,
name: "Example-Security-Monitoring",
rule: {
findingTypes: ["misconfiguration"],
query: "env:staging",
},
},
type: "mute_rules",
},
},
ruleId: VALID_MUTE_RULE_DATA_ID,
};
apiInstance
.updateSecurityFindingsAutomationMuteRule(params)
.then((data: v2.MuteRuleResponse) => {
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"