add start_date to suppression APIs (#2810)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
DataDog · Jan 2, 2025 · 13ad9a8 · 13ad9a8
1 parent 3560b01
commit 13ad9a8
Show file tree

Hide file tree

Showing 12 changed files with 170 additions and 38 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-26 16:01:47.001302",
-            "spec_repo_commit": "f2e98b01"
+            "regenerated": "2025-01-02 14:39:42.496279",
+            "spec_repo_commit": "b4e964b3"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-26 16:01:47.016270",
-            "spec_repo_commit": "f2e98b01"
+            "regenerated": "2025-01-02 14:39:42.511336",
+            "spec_repo_commit": "b4e964b3"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -24825,6 +24825,12 @@ components:
             as the search bar for detection rules.
           example: type:log_detection source:cloudtrail
           type: string
+        start_date:
+          description: A Unix millisecond timestamp giving the start date for the
+            suppression rule. After this date, it starts suppressing signals.
+          example: 1703187336000
+          format: int64
+          type: integer
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
             matches this query, it is suppressed and not triggered. Same syntax as
@@ -24880,6 +24886,12 @@ components:
             as the search bar for detection rules.
           example: type:log_detection source:cloudtrail
           type: string
+        start_date:
+          description: A Unix millisecond timestamp giving the start date for the
+            suppression rule. After this date, it starts suppressing signals.
+          example: 1703187336000
+          format: int64
+          type: integer
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
             matches this query, it is suppressed and is not triggered. It uses the
@@ -24966,6 +24978,15 @@ components:
             as the search bar for detection rules.
           example: type:log_detection source:cloudtrail
           type: string
+        start_date:
+          description: A Unix millisecond timestamp giving the start date for the
+            suppression rule. After this date, it starts suppressing signals. If unset,
+            the start date of the suppression rule is left untouched. If set to `null`,
+            the start date is removed.
+          example: 1703187336000
+          format: int64
+          nullable: true
+          type: integer
         suppression_query:
           description: The suppression query of the suppression rule. If a signal
             matches this query, it is suppressed and not triggered. Same syntax as

diff --git a/api/datadogV2/model_security_monitoring_suppression_attributes.go b/api/datadogV2/model_security_monitoring_suppression_attributes.go
@@ -28,6 +28,8 @@ type SecurityMonitoringSuppressionAttributes struct {
 	Name *string `json:"name,omitempty"`
 	// The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
 	RuleQuery *string `json:"rule_query,omitempty"`
+	// A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
+	StartDate *int64 `json:"start_date,omitempty"`
 	// The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
 	SuppressionQuery *string `json:"suppression_query,omitempty"`
 	// A Unix millisecond timestamp given the update date of the suppression rule.
@@ -310,6 +312,34 @@ func (o *SecurityMonitoringSuppressionAttributes) SetRuleQuery(v string) {
 	o.RuleQuery = &v
 }
 
+// GetStartDate returns the StartDate field value if set, zero value otherwise.
+func (o *SecurityMonitoringSuppressionAttributes) GetStartDate() int64 {
+	if o == nil || o.StartDate == nil {
+		var ret int64
+		return ret
+	}
+	return *o.StartDate
+}
+
+// GetStartDateOk returns a tuple with the StartDate field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SecurityMonitoringSuppressionAttributes) GetStartDateOk() (*int64, bool) {
+	if o == nil || o.StartDate == nil {
+		return nil, false
+	}
+	return o.StartDate, true
+}
+
+// HasStartDate returns a boolean if a field has been set.
+func (o *SecurityMonitoringSuppressionAttributes) HasStartDate() bool {
+	return o != nil && o.StartDate != nil
+}
+
+// SetStartDate gets a reference to the given int64 and assigns it to the StartDate field.
+func (o *SecurityMonitoringSuppressionAttributes) SetStartDate(v int64) {
+	o.StartDate = &v
+}
+
 // GetSuppressionQuery returns the SuppressionQuery field value if set, zero value otherwise.
 func (o *SecurityMonitoringSuppressionAttributes) GetSuppressionQuery() string {
 	if o == nil || o.SuppressionQuery == nil {
@@ -455,6 +485,9 @@ func (o SecurityMonitoringSuppressionAttributes) MarshalJSON() ([]byte, error) {
 	if o.RuleQuery != nil {
 		toSerialize["rule_query"] = o.RuleQuery
 	}
+	if o.StartDate != nil {
+		toSerialize["start_date"] = o.StartDate
+	}
 	if o.SuppressionQuery != nil {
 		toSerialize["suppression_query"] = o.SuppressionQuery
 	}
@@ -486,6 +519,7 @@ func (o *SecurityMonitoringSuppressionAttributes) UnmarshalJSON(bytes []byte) (e
 		ExpirationDate     *int64                  `json:"expiration_date,omitempty"`
 		Name               *string                 `json:"name,omitempty"`
 		RuleQuery          *string                 `json:"rule_query,omitempty"`
+		StartDate          *int64                  `json:"start_date,omitempty"`
 		SuppressionQuery   *string                 `json:"suppression_query,omitempty"`
 		UpdateDate         *int64                  `json:"update_date,omitempty"`
 		Updater            *SecurityMonitoringUser `json:"updater,omitempty"`
@@ -496,7 +530,7 @@ func (o *SecurityMonitoringSuppressionAttributes) UnmarshalJSON(bytes []byte) (e
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"creation_date", "creator", "data_exclusion_query", "description", "editable", "enabled", "expiration_date", "name", "rule_query", "suppression_query", "update_date", "updater", "version"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"creation_date", "creator", "data_exclusion_query", "description", "editable", "enabled", "expiration_date", "name", "rule_query", "start_date", "suppression_query", "update_date", "updater", "version"})
 	} else {
 		return err
 	}
@@ -514,6 +548,7 @@ func (o *SecurityMonitoringSuppressionAttributes) UnmarshalJSON(bytes []byte) (e
 	o.ExpirationDate = all.ExpirationDate
 	o.Name = all.Name
 	o.RuleQuery = all.RuleQuery
+	o.StartDate = all.StartDate
 	o.SuppressionQuery = all.SuppressionQuery
 	o.UpdateDate = all.UpdateDate
 	if all.Updater != nil && all.Updater.UnparsedObject != nil && o.UnparsedObject == nil {

diff --git a/api/datadogV2/model_security_monitoring_suppression_create_attributes.go b/api/datadogV2/model_security_monitoring_suppression_create_attributes.go
@@ -24,6 +24,8 @@ type SecurityMonitoringSuppressionCreateAttributes struct {
 	Name string `json:"name"`
 	// The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
 	RuleQuery string `json:"rule_query"`
+	// A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
+	StartDate *int64 `json:"start_date,omitempty"`
 	// The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.
 	SuppressionQuery *string `json:"suppression_query,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
@@ -204,6 +206,34 @@ func (o *SecurityMonitoringSuppressionCreateAttributes) SetRuleQuery(v string) {
 	o.RuleQuery = v
 }
 
+// GetStartDate returns the StartDate field value if set, zero value otherwise.
+func (o *SecurityMonitoringSuppressionCreateAttributes) GetStartDate() int64 {
+	if o == nil || o.StartDate == nil {
+		var ret int64
+		return ret
+	}
+	return *o.StartDate
+}
+
+// GetStartDateOk returns a tuple with the StartDate field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *SecurityMonitoringSuppressionCreateAttributes) GetStartDateOk() (*int64, bool) {
+	if o == nil || o.StartDate == nil {
+		return nil, false
+	}
+	return o.StartDate, true
+}
+
+// HasStartDate returns a boolean if a field has been set.
+func (o *SecurityMonitoringSuppressionCreateAttributes) HasStartDate() bool {
+	return o != nil && o.StartDate != nil
+}
+
+// SetStartDate gets a reference to the given int64 and assigns it to the StartDate field.
+func (o *SecurityMonitoringSuppressionCreateAttributes) SetStartDate(v int64) {
+	o.StartDate = &v
+}
+
 // GetSuppressionQuery returns the SuppressionQuery field value if set, zero value otherwise.
 func (o *SecurityMonitoringSuppressionCreateAttributes) GetSuppressionQuery() string {
 	if o == nil || o.SuppressionQuery == nil {
@@ -250,6 +280,9 @@ func (o SecurityMonitoringSuppressionCreateAttributes) MarshalJSON() ([]byte, er
 	}
 	toSerialize["name"] = o.Name
 	toSerialize["rule_query"] = o.RuleQuery
+	if o.StartDate != nil {
+		toSerialize["start_date"] = o.StartDate
+	}
 	if o.SuppressionQuery != nil {
 		toSerialize["suppression_query"] = o.SuppressionQuery
 	}
@@ -269,6 +302,7 @@ func (o *SecurityMonitoringSuppressionCreateAttributes) UnmarshalJSON(bytes []by
 		ExpirationDate     *int64  `json:"expiration_date,omitempty"`
 		Name               *string `json:"name"`
 		RuleQuery          *string `json:"rule_query"`
+		StartDate          *int64  `json:"start_date,omitempty"`
 		SuppressionQuery   *string `json:"suppression_query,omitempty"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
@@ -285,7 +319,7 @@ func (o *SecurityMonitoringSuppressionCreateAttributes) UnmarshalJSON(bytes []by
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"data_exclusion_query", "description", "enabled", "expiration_date", "name", "rule_query", "suppression_query"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"data_exclusion_query", "description", "enabled", "expiration_date", "name", "rule_query", "start_date", "suppression_query"})
 	} else {
 		return err
 	}
@@ -295,6 +329,7 @@ func (o *SecurityMonitoringSuppressionCreateAttributes) UnmarshalJSON(bytes []by
 	o.ExpirationDate = all.ExpirationDate
 	o.Name = *all.Name
 	o.RuleQuery = *all.RuleQuery
+	o.StartDate = all.StartDate
 	o.SuppressionQuery = all.SuppressionQuery
 
 	if len(additionalProperties) > 0 {

diff --git a/api/datadogV2/model_security_monitoring_suppression_update_attributes.go b/api/datadogV2/model_security_monitoring_suppression_update_attributes.go
@@ -22,6 +22,8 @@ type SecurityMonitoringSuppressionUpdateAttributes struct {
 	Name *string `json:"name,omitempty"`
 	// The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
 	RuleQuery *string `json:"rule_query,omitempty"`
+	// A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to `null`, the start date is removed.
+	StartDate datadog.NullableInt64 `json:"start_date,omitempty"`
 	// The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
 	SuppressionQuery *string `json:"suppression_query,omitempty"`
 	// The current version of the suppression. This is optional, but it can help prevent concurrent modifications.
@@ -227,6 +229,45 @@ func (o *SecurityMonitoringSuppressionUpdateAttributes) SetRuleQuery(v string) {
 	o.RuleQuery = &v
 }
 
+// GetStartDate returns the StartDate field value if set, zero value otherwise (both if not set or set to explicit null).
+func (o *SecurityMonitoringSuppressionUpdateAttributes) GetStartDate() int64 {
+	if o == nil || o.StartDate.Get() == nil {
+		var ret int64
+		return ret
+	}
+	return *o.StartDate.Get()
+}
+
+// GetStartDateOk returns a tuple with the StartDate field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+// NOTE: If the value is an explicit nil, `nil, true` will be returned.
+func (o *SecurityMonitoringSuppressionUpdateAttributes) GetStartDateOk() (*int64, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return o.StartDate.Get(), o.StartDate.IsSet()
+}
+
+// HasStartDate returns a boolean if a field has been set.
+func (o *SecurityMonitoringSuppressionUpdateAttributes) HasStartDate() bool {
+	return o != nil && o.StartDate.IsSet()
+}
+
+// SetStartDate gets a reference to the given datadog.NullableInt64 and assigns it to the StartDate field.
+func (o *SecurityMonitoringSuppressionUpdateAttributes) SetStartDate(v int64) {
+	o.StartDate.Set(&v)
+}
+
+// SetStartDateNil sets the value for StartDate to be an explicit nil.
+func (o *SecurityMonitoringSuppressionUpdateAttributes) SetStartDateNil() {
+	o.StartDate.Set(nil)
+}
+
+// UnsetStartDate ensures that no value is present for StartDate, not even an explicit nil.
+func (o *SecurityMonitoringSuppressionUpdateAttributes) UnsetStartDate() {
+	o.StartDate.Unset()
+}
+
 // GetSuppressionQuery returns the SuppressionQuery field value if set, zero value otherwise.
 func (o *SecurityMonitoringSuppressionUpdateAttributes) GetSuppressionQuery() string {
 	if o == nil || o.SuppressionQuery == nil {
@@ -307,6 +348,9 @@ func (o SecurityMonitoringSuppressionUpdateAttributes) MarshalJSON() ([]byte, er
 	if o.RuleQuery != nil {
 		toSerialize["rule_query"] = o.RuleQuery
 	}
+	if o.StartDate.IsSet() {
+		toSerialize["start_date"] = o.StartDate.Get()
+	}
 	if o.SuppressionQuery != nil {
 		toSerialize["suppression_query"] = o.SuppressionQuery
 	}
@@ -329,6 +373,7 @@ func (o *SecurityMonitoringSuppressionUpdateAttributes) UnmarshalJSON(bytes []by
 		ExpirationDate     datadog.NullableInt64 `json:"expiration_date,omitempty"`
 		Name               *string               `json:"name,omitempty"`
 		RuleQuery          *string               `json:"rule_query,omitempty"`
+		StartDate          datadog.NullableInt64 `json:"start_date,omitempty"`
 		SuppressionQuery   *string               `json:"suppression_query,omitempty"`
 		Version            *int32                `json:"version,omitempty"`
 	}{}
@@ -337,7 +382,7 @@ func (o *SecurityMonitoringSuppressionUpdateAttributes) UnmarshalJSON(bytes []by
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"data_exclusion_query", "description", "enabled", "expiration_date", "name", "rule_query", "suppression_query", "version"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"data_exclusion_query", "description", "enabled", "expiration_date", "name", "rule_query", "start_date", "suppression_query", "version"})
 	} else {
 		return err
 	}
@@ -347,6 +392,7 @@ func (o *SecurityMonitoringSuppressionUpdateAttributes) UnmarshalJSON(bytes []by
 	o.ExpirationDate = all.ExpirationDate
 	o.Name = all.Name
 	o.RuleQuery = all.RuleQuery
+	o.StartDate = all.StartDate
 	o.SuppressionQuery = all.SuppressionQuery
 	o.Version = all.Version
 

diff --git a/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression.go b/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression.go
@@ -18,6 +18,7 @@ func main() {
 			Attributes: datadogV2.SecurityMonitoringSuppressionCreateAttributes{
 				Description:      datadog.PtrString("This rule suppresses low-severity signals in staging environments."),
 				Enabled:          true,
+				StartDate:        datadog.PtrInt64(1637493071000),
 				ExpirationDate:   datadog.PtrInt64(1638443471000),
 				Name:             "Example-Security-Monitoring",
 				RuleQuery:        "type:log_detection source:cloudtrail",

diff --git a/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.go b/examples/v2/security-monitoring/CreateSecurityMonitoringSuppression_3192265332.go
@@ -18,6 +18,7 @@ func main() {
 			Attributes: datadogV2.SecurityMonitoringSuppressionCreateAttributes{
 				Description:        datadog.PtrString("This rule suppresses low-severity signals in staging environments."),
 				Enabled:            true,
+				StartDate:          datadog.PtrInt64(1637493071000),
 				ExpirationDate:     datadog.PtrInt64(1638443471000),
 				Name:               "Example-Security-Monitoring",
 				RuleQuery:          "type:log_detection source:cloudtrail",

diff --git a/...Feature_Security_Monitoring/Scenario_Create_a_suppression_rule_returns_OK_response.freeze b/...Feature_Security_Monitoring/Scenario_Create_a_suppression_rule_returns_OK_response.freeze
@@ -1 +1 @@
-2024-05-20T17:07:03.155Z
+2024-11-27T15:22:34.711Z
diff --git a/...2/Feature_Security_Monitoring/Scenario_Create_a_suppression_rule_returns_OK_response.yaml b/...2/Feature_Security_Monitoring/Scenario_Create_a_suppression_rule_returns_OK_response.yaml
@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: |
-      {"data":{"attributes":{"description":"This rule suppresses low-severity signals in staging environments.","enabled":true,"expiration_date":1718039223000,"name":"Test-Create_a_suppression_rule_returns_OK_response-1716224823","rule_query":"type:log_detection source:cloudtrail","suppression_query":"env:staging status:low"},"type":"suppressions"}}
+      {"data":{"attributes":{"description":"This rule suppresses low-severity signals in staging environments.","enabled":true,"expiration_date":1734535354000,"name":"Test-Create_a_suppression_rule_returns_OK_response-1732720954","rule_query":"type:log_detection source:cloudtrail","start_date":1733584954000,"suppression_query":"env:staging status:low"},"type":"suppressions"}}
     form: {}
     headers:
       Accept:
@@ -12,16 +12,15 @@ interactions:
     method: POST
     url: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions
   response:
-    body: '{"data":{"id":"8qj-mmz-zym","attributes":{"name":"Test-Create_a_suppression_rule_returns_OK_response-1716224823","enabled":true,"description":"This
-      rule suppresses low-severity signals in staging environments.","rule_query":"type:log_detection
-      source:cloudtrail","suppression_query":"env:staging status:low","data_exclusion_query":"","expiration_date":1718039223000,"version":1,"creation_date":1716224823374,"update_date":1716224823374,"creator":{"name":null,"handle":"frog@datadoghq.com"},"updater":{"name":null,"handle":"frog@datadoghq.com"}},"type":"suppressions"}}
-
-      '
+    body: '{"data":{"id":"ejv-ksi-r4j","type":"suppressions","attributes":{"creation_date":1732720954868,"creator":{"handle":"frog@datadoghq.com","name":""},"data_exclusion_query":"","description":"This
+      rule suppresses low-severity signals in staging environments.","editable":true,"enabled":true,"expiration_date":1734535354000,"name":"Test-Create_a_suppression_rule_returns_OK_response-1732720954","rule_query":"type:log_detection
+      source:cloudtrail","start_date":1733584954000,"suppression_query":"env:staging
+      status:low","update_date":1732720954868,"updater":{"handle":"frog@datadoghq.com","name":""},"version":1}}}'
     code: 200
     duration: 0ms
     headers:
       Content-Type:
-      - application/json
+      - application/vnd.api+json
     status: 200 OK
 - request:
     body: ''
@@ -31,13 +30,11 @@ interactions:
       - '*/*'
     id: 1
     method: DELETE
-    url: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/8qj-mmz-zym
+    url: https://api.datadoghq.com/api/v2/security_monitoring/configuration/suppressions/ejv-ksi-r4j
   response:
     body: ''
     code: 204
     duration: 0ms
-    headers:
-      Content-Type:
-      - text/html; charset=utf-8
+    headers: {}
     status: 204 No Content
 version: 2
diff --git a/...ing/Scenario_Create_a_suppression_rule_with_an_exclusion_query_returns_OK_response.freeze b/...ing/Scenario_Create_a_suppression_rule_with_an_exclusion_query_returns_OK_response.freeze
@@ -1 +1 @@
-2024-05-20T17:07:12.131Z
+2024-11-27T15:24:35.169Z