Add monitor draft status field (#3095)

* Regenerate client from commit 38b3c05a of spec repo

* Update cassettes with default status

---------

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
Co-authored-by: Shane Yuan <shane.yuan@datadoghq.com>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-04 12:51:38.802136",
-            "spec_repo_commit": "35a63137"
+            "regenerated": "2025-06-04 17:40:38.341419",
+            "spec_repo_commit": "38b3c05a"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-04 12:51:38.821208",
-            "spec_repo_commit": "35a63137"
+            "regenerated": "2025-06-04 17:40:38.359022",
+            "spec_repo_commit": "38b3c05a"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -6742,6 +6742,8 @@ components:
           nullable: true
           readOnly: true
           type: string
+        draft_status:
+          $ref: '#/components/schemas/MonitorDraftStatus'
         id:
           description: ID of this monitor.
           format: int64
@@ -6834,6 +6836,28 @@ components:
       - FIREFOX_LAPTOP_LARGE
       - FIREFOX_TABLET
       - FIREFOX_MOBILE_SMALL
+    MonitorDraftStatus:
+      default: published
+      description: 'Indicates whether the monitor is in a draft or published state.
+
+
+        `draft`: The monitor appears as Draft and does not send notifications.
+
+        `published`: The monitor is active and evaluates conditions and notify as
+        configured.
+
+
+        This field is in preview. The draft value is only available to customers with
+        the feature enabled.
+
+        '
+      enum:
+      - draft
+      - published
+      type: string
+      x-enum-varnames:
+      - DRAFT
+      - PUBLISHED
     MonitorFormulaAndFunctionCostAggregator:
       description: Aggregation methods for metric queries.
       enum:
@@ -7917,6 +7941,8 @@ components:
           nullable: true
           readOnly: true
           type: string
+        draft_status:
+          $ref: '#/components/schemas/MonitorDraftStatus'
         id:
           description: ID of this monitor.
           format: int64

api/datadogV1/model_monitor.go

@@ -19,6 +19,14 @@ type Monitor struct {
 	Creator *Creator `json:"creator,omitempty"`
 	// Whether or not the monitor is deleted. (Always `null`)
 	Deleted datadog.NullableTime `json:"deleted,omitempty"`
+	// Indicates whether the monitor is in a draft or published state.
+	//
+	// `draft`: The monitor appears as Draft and does not send notifications.
+	// `published`: The monitor is active and evaluates conditions and notify as configured.
+	//
+	// This field is in preview. The draft value is only available to customers with the feature enabled.
+	//
+	DraftStatus *MonitorDraftStatus `json:"draft_status,omitempty"`
 	// ID of this monitor.
 	Id *int64 `json:"id,omitempty"`
 	// A list of active v1 downtimes that match this monitor.
@@ -58,6 +66,8 @@ type Monitor struct {
 // will change when the set of required properties is changed.
 func NewMonitor(query string, typeVar MonitorType) *Monitor {
 	this := Monitor{}
+	var draftStatus MonitorDraftStatus = MONITORDRAFTSTATUS_PUBLISHED
+	this.DraftStatus = &draftStatus
 	this.Query = query
 	this.Type = typeVar
 	return &this
@@ -68,6 +78,8 @@ func NewMonitor(query string, typeVar MonitorType) *Monitor {
 // but it doesn't guarantee that properties required by API are set.
 func NewMonitorWithDefaults() *Monitor {
 	this := Monitor{}
+	var draftStatus MonitorDraftStatus = MONITORDRAFTSTATUS_PUBLISHED
+	this.DraftStatus = &draftStatus
 	return &this
 }
 
@@ -166,6 +178,34 @@ func (o *Monitor) UnsetDeleted() {
 	o.Deleted.Unset()
 }
 
+// GetDraftStatus returns the DraftStatus field value if set, zero value otherwise.
+func (o *Monitor) GetDraftStatus() MonitorDraftStatus {
+	if o == nil || o.DraftStatus == nil {
+		var ret MonitorDraftStatus
+		return ret
+	}
+	return *o.DraftStatus
+}
+
+// GetDraftStatusOk returns a tuple with the DraftStatus field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *Monitor) GetDraftStatusOk() (*MonitorDraftStatus, bool) {
+	if o == nil || o.DraftStatus == nil {
+		return nil, false
+	}
+	return o.DraftStatus, true
+}
+
+// HasDraftStatus returns a boolean if a field has been set.
+func (o *Monitor) HasDraftStatus() bool {
+	return o != nil && o.DraftStatus != nil
+}
+
+// SetDraftStatus gets a reference to the given MonitorDraftStatus and assigns it to the DraftStatus field.
+func (o *Monitor) SetDraftStatus(v MonitorDraftStatus) {
+	o.DraftStatus = &v
+}
+
 // GetId returns the Id field value if set, zero value otherwise.
 func (o *Monitor) GetId() int64 {
 	if o == nil || o.Id == nil {
@@ -589,6 +629,9 @@ func (o Monitor) MarshalJSON() ([]byte, error) {
 	if o.Deleted.IsSet() {
 		toSerialize["deleted"] = o.Deleted.Get()
 	}
+	if o.DraftStatus != nil {
+		toSerialize["draft_status"] = o.DraftStatus
+	}
 	if o.Id != nil {
 		toSerialize["id"] = o.Id
 	}
@@ -644,6 +687,7 @@ func (o *Monitor) UnmarshalJSON(bytes []byte) (err error) {
 		Created           *time.Time                   `json:"created,omitempty"`
 		Creator           *Creator                     `json:"creator,omitempty"`
 		Deleted           datadog.NullableTime         `json:"deleted,omitempty"`
+		DraftStatus       *MonitorDraftStatus          `json:"draft_status,omitempty"`
 		Id                *int64                       `json:"id,omitempty"`
 		MatchingDowntimes []MatchingDowntime           `json:"matching_downtimes,omitempty"`
 		Message           *string                      `json:"message,omitempty"`
@@ -670,7 +714,7 @@ func (o *Monitor) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"created", "creator", "deleted", "id", "matching_downtimes", "message", "modified", "multi", "name", "options", "overall_state", "priority", "query", "restricted_roles", "state", "tags", "type"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"created", "creator", "deleted", "draft_status", "id", "matching_downtimes", "message", "modified", "multi", "name", "options", "overall_state", "priority", "query", "restricted_roles", "state", "tags", "type"})
 	} else {
 		return err
 	}
@@ -682,6 +726,11 @@ func (o *Monitor) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	o.Creator = all.Creator
 	o.Deleted = all.Deleted
+	if all.DraftStatus != nil && !all.DraftStatus.IsValid() {
+		hasInvalidField = true
+	} else {
+		o.DraftStatus = all.DraftStatus
+	}
 	o.Id = all.Id
 	o.MatchingDowntimes = all.MatchingDowntimes
 	o.Message = all.Message

api/datadogV1/model_monitor_draft_status.go

@@ -0,0 +1,71 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+package datadogV1
+
+import (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// MonitorDraftStatus Indicates whether the monitor is in a draft or published state.
+//
+// `draft`: The monitor appears as Draft and does not send notifications.
+// `published`: The monitor is active and evaluates conditions and notify as configured.
+//
+// This field is in preview. The draft value is only available to customers with the feature enabled.
+type MonitorDraftStatus string
+
+// List of MonitorDraftStatus.
+const (
+	MONITORDRAFTSTATUS_DRAFT     MonitorDraftStatus = "draft"
+	MONITORDRAFTSTATUS_PUBLISHED MonitorDraftStatus = "published"
+)
+
+var allowedMonitorDraftStatusEnumValues = []MonitorDraftStatus{
+	MONITORDRAFTSTATUS_DRAFT,
+	MONITORDRAFTSTATUS_PUBLISHED,
+}
+
+// GetAllowedValues reeturns the list of possible values.
+func (v *MonitorDraftStatus) GetAllowedValues() []MonitorDraftStatus {
+	return allowedMonitorDraftStatusEnumValues
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (v *MonitorDraftStatus) UnmarshalJSON(src []byte) error {
+	var value string
+	err := datadog.Unmarshal(src, &value)
+	if err != nil {
+		return err
+	}
+	*v = MonitorDraftStatus(value)
+	return nil
+}
+
+// NewMonitorDraftStatusFromValue returns a pointer to a valid MonitorDraftStatus
+// for the value passed as argument, or an error if the value passed is not allowed by the enum.
+func NewMonitorDraftStatusFromValue(v string) (*MonitorDraftStatus, error) {
+	ev := MonitorDraftStatus(v)
+	if ev.IsValid() {
+		return &ev, nil
+	}
+	return nil, fmt.Errorf("invalid value '%v' for MonitorDraftStatus: valid values are %v", v, allowedMonitorDraftStatusEnumValues)
+}
+
+// IsValid return true if the value is valid for the enum, false otherwise.
+func (v MonitorDraftStatus) IsValid() bool {
+	for _, existing := range allowedMonitorDraftStatusEnumValues {
+		if existing == v {
+			return true
+		}
+	}
+	return false
+}
+
+// Ptr returns reference to MonitorDraftStatus value.
+func (v MonitorDraftStatus) Ptr() *MonitorDraftStatus {
+	return &v
+}

api/datadogV1/model_monitor_update_request.go

@@ -18,6 +18,14 @@ type MonitorUpdateRequest struct {
 	Creator *Creator `json:"creator,omitempty"`
 	// Whether or not the monitor is deleted. (Always `null`)
 	Deleted datadog.NullableTime `json:"deleted,omitempty"`
+	// Indicates whether the monitor is in a draft or published state.
+	//
+	// `draft`: The monitor appears as Draft and does not send notifications.
+	// `published`: The monitor is active and evaluates conditions and notify as configured.
+	//
+	// This field is in preview. The draft value is only available to customers with the feature enabled.
+	//
+	DraftStatus *MonitorDraftStatus `json:"draft_status,omitempty"`
 	// ID of this monitor.
 	Id *int64 `json:"id,omitempty"`
 	// A message to include with notifications for this monitor.
@@ -55,6 +63,8 @@ type MonitorUpdateRequest struct {
 // will change when the set of required properties is changed.
 func NewMonitorUpdateRequest() *MonitorUpdateRequest {
 	this := MonitorUpdateRequest{}
+	var draftStatus MonitorDraftStatus = MONITORDRAFTSTATUS_PUBLISHED
+	this.DraftStatus = &draftStatus
 	return &this
 }
 
@@ -63,6 +73,8 @@ func NewMonitorUpdateRequest() *MonitorUpdateRequest {
 // but it doesn't guarantee that properties required by API are set.
 func NewMonitorUpdateRequestWithDefaults() *MonitorUpdateRequest {
 	this := MonitorUpdateRequest{}
+	var draftStatus MonitorDraftStatus = MONITORDRAFTSTATUS_PUBLISHED
+	this.DraftStatus = &draftStatus
 	return &this
 }
 
@@ -161,6 +173,34 @@ func (o *MonitorUpdateRequest) UnsetDeleted() {
 	o.Deleted.Unset()
 }
 
+// GetDraftStatus returns the DraftStatus field value if set, zero value otherwise.
+func (o *MonitorUpdateRequest) GetDraftStatus() MonitorDraftStatus {
+	if o == nil || o.DraftStatus == nil {
+		var ret MonitorDraftStatus
+		return ret
+	}
+	return *o.DraftStatus
+}
+
+// GetDraftStatusOk returns a tuple with the DraftStatus field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *MonitorUpdateRequest) GetDraftStatusOk() (*MonitorDraftStatus, bool) {
+	if o == nil || o.DraftStatus == nil {
+		return nil, false
+	}
+	return o.DraftStatus, true
+}
+
+// HasDraftStatus returns a boolean if a field has been set.
+func (o *MonitorUpdateRequest) HasDraftStatus() bool {
+	return o != nil && o.DraftStatus != nil
+}
+
+// SetDraftStatus gets a reference to the given MonitorDraftStatus and assigns it to the DraftStatus field.
+func (o *MonitorUpdateRequest) SetDraftStatus(v MonitorDraftStatus) {
+	o.DraftStatus = &v
+}
+
 // GetId returns the Id field value if set, zero value otherwise.
 func (o *MonitorUpdateRequest) GetId() int64 {
 	if o == nil || o.Id == nil {
@@ -566,6 +606,9 @@ func (o MonitorUpdateRequest) MarshalJSON() ([]byte, error) {
 	if o.Deleted.IsSet() {
 		toSerialize["deleted"] = o.Deleted.Get()
 	}
+	if o.DraftStatus != nil {
+		toSerialize["draft_status"] = o.DraftStatus
+	}
 	if o.Id != nil {
 		toSerialize["id"] = o.Id
 	}
@@ -622,6 +665,7 @@ func (o *MonitorUpdateRequest) UnmarshalJSON(bytes []byte) (err error) {
 		Created         *time.Time                   `json:"created,omitempty"`
 		Creator         *Creator                     `json:"creator,omitempty"`
 		Deleted         datadog.NullableTime         `json:"deleted,omitempty"`
+		DraftStatus     *MonitorDraftStatus          `json:"draft_status,omitempty"`
 		Id              *int64                       `json:"id,omitempty"`
 		Message         *string                      `json:"message,omitempty"`
 		Modified        *time.Time                   `json:"modified,omitempty"`
@@ -641,7 +685,7 @@ func (o *MonitorUpdateRequest) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"created", "creator", "deleted", "id", "message", "modified", "multi", "name", "options", "overall_state", "priority", "query", "restricted_roles", "state", "tags", "type"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"created", "creator", "deleted", "draft_status", "id", "message", "modified", "multi", "name", "options", "overall_state", "priority", "query", "restricted_roles", "state", "tags", "type"})
 	} else {
 		return err
 	}
@@ -653,6 +697,11 @@ func (o *MonitorUpdateRequest) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	o.Creator = all.Creator
 	o.Deleted = all.Deleted
+	if all.DraftStatus != nil && !all.DraftStatus.IsValid() {
+		hasInvalidField = true
+	} else {
+		o.DraftStatus = all.DraftStatus
+	}
 	o.Id = all.Id
 	o.Message = all.Message
 	o.Modified = all.Modified

examples/v1/monitors/CreateMonitor_1539578087.go

@@ -40,7 +40,8 @@ func main() {
 				},
 			},
 		},
-		Type: datadogV1.MONITORTYPE_QUERY_ALERT,
+		Type:        datadogV1.MONITORTYPE_QUERY_ALERT,
+		DraftStatus: datadogV1.MONITORDRAFTSTATUS_PUBLISHED.Ptr(),
 	}
 	ctx := datadog.NewDefaultContext(context.Background())
 	configuration := datadog.NewConfiguration()

examples/v1/monitors/CreateMonitor_440013737.go

@@ -28,6 +28,7 @@ func main() {
 				Critical: datadog.PtrFloat64(1),
 			},
 		},
+		DraftStatus: datadogV1.MONITORDRAFTSTATUS_DRAFT.Ptr(),
 	}
 	ctx := datadog.NewDefaultContext(context.Background())
 	configuration := datadog.NewConfiguration()

tests/api/datadogV1/cassettes/TestMonitorCanDeleteErrors.yaml

@@ -13,7 +13,7 @@ interactions:
         remote_addr: ""
         request_uri: ""
         body: |
-            {"query":"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} \u003e 100","type":"query alert"}
+            {"draft_status":"published","query":"avg(last_5m):sum:system.net.bytes_rcvd{host:host0} \u003e 100","type":"query alert"}
         form: {}
         headers:
             Accept:
@@ -83,7 +83,7 @@ interactions:
         remote_addr: ""
         request_uri: ""
         body: |
-            {"query":"49714524","type":"composite"}
+            {"draft_status":"published","query":"49714524","type":"composite"}
         form: {}
         headers:
             Accept:

tests/api/datadogV1/cassettes/TestMonitorUpdateErrors/400_Bad_Request.yaml

@@ -13,7 +13,7 @@ interactions:
         remote_addr: ""
         request_uri: ""
         body: |
-            {"type":"composite"}
+            {"draft_status":"published","type":"composite"}
         form: {}
         headers:
             Accept: