Skip to content

Commit f2e72d9

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Security Monitoring - Related Suppressions for a Rule (DataDog#3318)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 0125c70 commit f2e72d9

16 files changed

Lines changed: 504 additions & 0 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64757,6 +64757,65 @@ paths:
6475764757
tags:
6475864758
- Security Monitoring
6475964759
x-codegen-request-body-name: body
64760+
/api/v2/security_monitoring/configuration/suppressions/rules:
64761+
post:
64762+
description: Get the list of suppressions that would affect a rule.
64763+
operationId: GetSuppressionsAffectingFutureRule
64764+
requestBody:
64765+
content:
64766+
application/json:
64767+
schema:
64768+
$ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
64769+
required: true
64770+
responses:
64771+
'200':
64772+
content:
64773+
application/json:
64774+
schema:
64775+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
64776+
description: OK
64777+
'400':
64778+
$ref: '#/components/responses/BadRequestResponse'
64779+
'403':
64780+
$ref: '#/components/responses/NotAuthorizedResponse'
64781+
'429':
64782+
$ref: '#/components/responses/TooManyRequestsResponse'
64783+
security:
64784+
- apiKeyAuth: []
64785+
appKeyAuth: []
64786+
- AuthZ:
64787+
- security_monitoring_suppressions_read
64788+
summary: Get suppressions affecting future rule
64789+
tags:
64790+
- Security Monitoring
64791+
/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}:
64792+
get:
64793+
description: Get the list of suppressions that affect a specific existing rule
64794+
by its ID.
64795+
operationId: GetSuppressionsAffectingRule
64796+
parameters:
64797+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
64798+
responses:
64799+
'200':
64800+
content:
64801+
application/json:
64802+
schema:
64803+
$ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
64804+
description: OK
64805+
'403':
64806+
$ref: '#/components/responses/NotAuthorizedResponse'
64807+
'404':
64808+
$ref: '#/components/responses/NotFoundResponse'
64809+
'429':
64810+
$ref: '#/components/responses/TooManyRequestsResponse'
64811+
security:
64812+
- apiKeyAuth: []
64813+
appKeyAuth: []
64814+
- AuthZ:
64815+
- security_monitoring_suppressions_read
64816+
summary: Get suppressions affecting a specific rule
64817+
tags:
64818+
- Security Monitoring
6476064819
/api/v2/security_monitoring/configuration/suppressions/{suppression_id}:
6476164820
delete:
6476264821
description: Delete a specific suppression rule.

‎api/datadogV2/api_security_monitoring.go‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2683,6 +2683,164 @@ func (a *SecurityMonitoringApi) GetSignalNotificationRules(ctx _context.Context)
26832683
return localVarReturnValue, localVarHTTPResponse, nil
26842684
}
26852685

2686+
// GetSuppressionsAffectingFutureRule Get suppressions affecting future rule.
2687+
// Get the list of suppressions that would affect a rule.
2688+
func (a *SecurityMonitoringApi) GetSuppressionsAffectingFutureRule(ctx _context.Context, body SecurityMonitoringRuleCreatePayload) (SecurityMonitoringSuppressionsResponse, *_nethttp.Response, error) {
2689+
var (
2690+
localVarHTTPMethod = _nethttp.MethodPost
2691+
localVarPostBody interface{}
2692+
localVarReturnValue SecurityMonitoringSuppressionsResponse
2693+
)
2694+
2695+
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.SecurityMonitoringApi.GetSuppressionsAffectingFutureRule")
2696+
if err != nil {
2697+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
2698+
}
2699+
2700+
localVarPath := localBasePath + "/api/v2/security_monitoring/configuration/suppressions/rules"
2701+
2702+
localVarHeaderParams := make(map[string]string)
2703+
localVarQueryParams := _neturl.Values{}
2704+
localVarFormParams := _neturl.Values{}
2705+
localVarHeaderParams["Content-Type"] = "application/json"
2706+
localVarHeaderParams["Accept"] = "application/json"
2707+
2708+
// body params
2709+
localVarPostBody = &body
2710+
if a.Client.Cfg.DelegatedTokenConfig != nil {
2711+
err = datadog.UseDelegatedTokenAuth(ctx, &localVarHeaderParams, a.Client.Cfg.DelegatedTokenConfig)
2712+
if err != nil {
2713+
return localVarReturnValue, nil, err
2714+
}
2715+
} else {
2716+
datadog.SetAuthKeys(
2717+
ctx,
2718+
&localVarHeaderParams,
2719+
[2]string{"apiKeyAuth", "DD-API-KEY"},
2720+
[2]string{"appKeyAuth", "DD-APPLICATION-KEY"},
2721+
)
2722+
}
2723+
req, err := a.Client.PrepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, nil)
2724+
if err != nil {
2725+
return localVarReturnValue, nil, err
2726+
}
2727+
2728+
localVarHTTPResponse, err := a.Client.CallAPI(req)
2729+
if err != nil || localVarHTTPResponse == nil {
2730+
return localVarReturnValue, localVarHTTPResponse, err
2731+
}
2732+
2733+
localVarBody, err := datadog.ReadBody(localVarHTTPResponse)
2734+
if err != nil {
2735+
return localVarReturnValue, localVarHTTPResponse, err
2736+
}
2737+
2738+
if localVarHTTPResponse.StatusCode >= 300 {
2739+
newErr := datadog.GenericOpenAPIError{
2740+
ErrorBody: localVarBody,
2741+
ErrorMessage: localVarHTTPResponse.Status,
2742+
}
2743+
if localVarHTTPResponse.StatusCode == 400 || localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 429 {
2744+
var v APIErrorResponse
2745+
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
2746+
if err != nil {
2747+
return localVarReturnValue, localVarHTTPResponse, newErr
2748+
}
2749+
newErr.ErrorModel = v
2750+
}
2751+
return localVarReturnValue, localVarHTTPResponse, newErr
2752+
}
2753+
2754+
err = a.Client.Decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
2755+
if err != nil {
2756+
newErr := datadog.GenericOpenAPIError{
2757+
ErrorBody: localVarBody,
2758+
ErrorMessage: err.Error(),
2759+
}
2760+
return localVarReturnValue, localVarHTTPResponse, newErr
2761+
}
2762+
2763+
return localVarReturnValue, localVarHTTPResponse, nil
2764+
}
2765+
2766+
// GetSuppressionsAffectingRule Get suppressions affecting a specific rule.
2767+
// Get the list of suppressions that affect a specific existing rule by its ID.
2768+
func (a *SecurityMonitoringApi) GetSuppressionsAffectingRule(ctx _context.Context, ruleId string) (SecurityMonitoringSuppressionsResponse, *_nethttp.Response, error) {
2769+
var (
2770+
localVarHTTPMethod = _nethttp.MethodGet
2771+
localVarPostBody interface{}
2772+
localVarReturnValue SecurityMonitoringSuppressionsResponse
2773+
)
2774+
2775+
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.SecurityMonitoringApi.GetSuppressionsAffectingRule")
2776+
if err != nil {
2777+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
2778+
}
2779+
2780+
localVarPath := localBasePath + "/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}"
2781+
localVarPath = datadog.ReplacePathParameter(localVarPath, "{rule_id}", _neturl.PathEscape(datadog.ParameterToString(ruleId, "")))
2782+
2783+
localVarHeaderParams := make(map[string]string)
2784+
localVarQueryParams := _neturl.Values{}
2785+
localVarFormParams := _neturl.Values{}
2786+
localVarHeaderParams["Accept"] = "application/json"
2787+
2788+
if a.Client.Cfg.DelegatedTokenConfig != nil {
2789+
err = datadog.UseDelegatedTokenAuth(ctx, &localVarHeaderParams, a.Client.Cfg.DelegatedTokenConfig)
2790+
if err != nil {
2791+
return localVarReturnValue, nil, err
2792+
}
2793+
} else {
2794+
datadog.SetAuthKeys(
2795+
ctx,
2796+
&localVarHeaderParams,
2797+
[2]string{"apiKeyAuth", "DD-API-KEY"},
2798+
[2]string{"appKeyAuth", "DD-APPLICATION-KEY"},
2799+
)
2800+
}
2801+
req, err := a.Client.PrepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, nil)
2802+
if err != nil {
2803+
return localVarReturnValue, nil, err
2804+
}
2805+
2806+
localVarHTTPResponse, err := a.Client.CallAPI(req)
2807+
if err != nil || localVarHTTPResponse == nil {
2808+
return localVarReturnValue, localVarHTTPResponse, err
2809+
}
2810+
2811+
localVarBody, err := datadog.ReadBody(localVarHTTPResponse)
2812+
if err != nil {
2813+
return localVarReturnValue, localVarHTTPResponse, err
2814+
}
2815+
2816+
if localVarHTTPResponse.StatusCode >= 300 {
2817+
newErr := datadog.GenericOpenAPIError{
2818+
ErrorBody: localVarBody,
2819+
ErrorMessage: localVarHTTPResponse.Status,
2820+
}
2821+
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 404 || localVarHTTPResponse.StatusCode == 429 {
2822+
var v APIErrorResponse
2823+
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
2824+
if err != nil {
2825+
return localVarReturnValue, localVarHTTPResponse, newErr
2826+
}
2827+
newErr.ErrorModel = v
2828+
}
2829+
return localVarReturnValue, localVarHTTPResponse, newErr
2830+
}
2831+
2832+
err = a.Client.Decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
2833+
if err != nil {
2834+
newErr := datadog.GenericOpenAPIError{
2835+
ErrorBody: localVarBody,
2836+
ErrorMessage: err.Error(),
2837+
}
2838+
return localVarReturnValue, localVarHTTPResponse, newErr
2839+
}
2840+
2841+
return localVarReturnValue, localVarHTTPResponse, nil
2842+
}
2843+
26862844
// GetVulnerabilityNotificationRule Get details of a vulnerability notification rule.
26872845
// Get the details of a notification rule for security vulnerabilities.
26882846
func (a *SecurityMonitoringApi) GetVulnerabilityNotificationRule(ctx _context.Context, id string) (NotificationRuleResponse, *_nethttp.Response, error) {

‎api/datadogV2/doc.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,8 @@
428428
// - [SecurityMonitoringApi.GetSecurityMonitoringSuppression]
429429
// - [SecurityMonitoringApi.GetSignalNotificationRule]
430430
// - [SecurityMonitoringApi.GetSignalNotificationRules]
431+
// - [SecurityMonitoringApi.GetSuppressionsAffectingFutureRule]
432+
// - [SecurityMonitoringApi.GetSuppressionsAffectingRule]
431433
// - [SecurityMonitoringApi.GetVulnerabilityNotificationRule]
432434
// - [SecurityMonitoringApi.GetVulnerabilityNotificationRules]
433435
// - [SecurityMonitoringApi.ListAssetsSBOMs]

‎examples/v2/security-monitoring/GetSuppressionsAffectingFutureRule.go‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
// Get suppressions affecting future rule returns "OK" response
2+
3+
package main
4+
5+
import (
6+
"context"
7+
"encoding/json"
8+
"fmt"
9+
"os"
10+
11+
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
12+
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
13+
)
14+
15+
func main() {
16+
body := datadogV2.SecurityMonitoringRuleCreatePayload{
17+
SecurityMonitoringStandardRuleCreatePayload: &datadogV2.SecurityMonitoringStandardRuleCreatePayload{
18+
Name: "Example-Security-Monitoring",
19+
Queries: []datadogV2.SecurityMonitoringStandardRuleQuery{
20+
{
21+
Query: datadog.PtrString("@test:true"),
22+
Aggregation: datadogV2.SECURITYMONITORINGRULEQUERYAGGREGATION_COUNT.Ptr(),
23+
GroupByFields: []string{},
24+
DistinctFields: []string{},
25+
Metrics: []string{},
26+
},
27+
},
28+
Filters: []datadogV2.SecurityMonitoringFilter{},
29+
Cases: []datadogV2.SecurityMonitoringRuleCaseCreate{
30+
{
31+
Name: datadog.PtrString(""),
32+
Status: datadogV2.SECURITYMONITORINGRULESEVERITY_INFO,
33+
Condition: datadog.PtrString("a > 0"),
34+
Notifications: []string{},
35+
},
36+
},
37+
Options: datadogV2.SecurityMonitoringRuleOptions{
38+
EvaluationWindow: datadogV2.SECURITYMONITORINGRULEEVALUATIONWINDOW_FIFTEEN_MINUTES.Ptr(),
39+
KeepAlive: datadogV2.SECURITYMONITORINGRULEKEEPALIVE_ONE_HOUR.Ptr(),
40+
MaxSignalDuration: datadogV2.SECURITYMONITORINGRULEMAXSIGNALDURATION_ONE_DAY.Ptr(),
41+
},
42+
Message: "Test rule",
43+
Tags: []string{},
44+
IsEnabled: true,
45+
Type: datadogV2.SECURITYMONITORINGRULETYPECREATE_LOG_DETECTION.Ptr(),
46+
}}
47+
ctx := datadog.NewDefaultContext(context.Background())
48+
configuration := datadog.NewConfiguration()
49+
apiClient := datadog.NewAPIClient(configuration)
50+
api := datadogV2.NewSecurityMonitoringApi(apiClient)
51+
resp, r, err := api.GetSuppressionsAffectingFutureRule(ctx, body)
52+
53+
if err != nil {
54+
fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.GetSuppressionsAffectingFutureRule`: %v\n", err)
55+
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
56+
}
57+
58+
responseContent, _ := json.MarshalIndent(resp, "", " ")
59+
fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.GetSuppressionsAffectingFutureRule`:\n%s\n", responseContent)
60+
}

‎examples/v2/security-monitoring/GetSuppressionsAffectingRule.go‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Get suppressions affecting a specific rule returns "OK" response
2+
3+
package main
4+
5+
import (
6+
"context"
7+
"encoding/json"
8+
"fmt"
9+
"os"
10+
11+
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
12+
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
13+
)
14+
15+
func main() {
16+
// there is a valid "security_rule" in the system
17+
SecurityRuleID := os.Getenv("SECURITY_RULE_ID")
18+
19+
ctx := datadog.NewDefaultContext(context.Background())
20+
configuration := datadog.NewConfiguration()
21+
apiClient := datadog.NewAPIClient(configuration)
22+
api := datadogV2.NewSecurityMonitoringApi(apiClient)
23+
resp, r, err := api.GetSuppressionsAffectingRule(ctx, SecurityRuleID)
24+
25+
if err != nil {
26+
fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.GetSuppressionsAffectingRule`: %v\n", err)
27+
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
28+
}
29+
30+
responseContent, _ := json.MarshalIndent(resp, "", " ")
31+
fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.GetSuppressionsAffectingRule`:\n%s\n", responseContent)
32+
}

‎tests/scenarios/cassettes/TestScenarios/v2/Feature_Security_Monitoring/Scenario_Get_suppressions_affecting_a_specific_rule_returns_Not_Found_response.freeze‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025-08-30T15:29:04.687Z

‎tests/scenarios/cassettes/TestScenarios/v2/Feature_Security_Monitoring/Scenario_Get_suppressions_affecting_a_specific_rule_returns_Not_Found_response.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
interactions:
2+
- request:
3+
body: ''
4+
form: {}
5+
headers:
6+
Accept:
7+
- application/json
8+
id: 0
9+
method: GET
10+
url: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/rules/aaa-bbb-ccc-ddd
11+
response:
12+
body: '{"errors":["not_found(Threat detection rule not found: aaa-bbb-ccc-ddd)"]}'
13+
code: 404
14+
duration: 0ms
15+
headers:
16+
Content-Type:
17+
- application/json
18+
status: 404 Not Found
19+
version: 2

‎tests/scenarios/cassettes/TestScenarios/v2/Feature_Security_Monitoring/Scenario_Get_suppressions_affecting_a_specific_rule_returns_OK_response.freeze‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025-08-30T11:40:50.061Z

0 commit comments

Comments
 (0)