Project: Host Maintenance Policy (#798)

* Added support for Host/VM Maintenance (#720)

* Added support for Host/VM Maintenance

* Fix lint

* Deprecate fields instead of removing them

* Made updates to address API spec changes

* Addressed additional API Spec changes (#771)

* Updated maintenance_policy_id to maintenance_policy

* Fix lint

* Modified maintenance/policies endpoint to reflect paginated response

* Add integration test for VM Maintenance Policy changes (#781)

* int_test

* lint-issue

* address_PR_comment

* fix

* address_comment

* fix

* clean up the fixtures

* clean up the fixtures

* Added `v4beta` notices for new fields and methods (#795)

* Added v4beta notices

* Fix tests

* Fix lint

---------

Co-authored-by: Vinay <[email protected]>

Author: ezilber-akamai

account_events.go

@@ -52,6 +52,25 @@ type Event struct {
 
 	// The total duration in seconds that it takes for the Event to complete.
 	Duration float64 `json:"duration"`
+
+	// The maintenance policy configured by the user for the event.
+	// NOTE: MaintenancePolicySet can only be used with v4beta.
+	MaintenancePolicySet string `json:"maintenance_policy_set"`
+
+	// Describes the nature of the event (e.g., whether it is scheduled or emergency).
+	Description string `json:"description"`
+
+	// The origin of the event (e.g., platform, user).
+	Source string `json:"source"`
+
+	// Scheduled start time for the event.
+	NotBefore *time.Time `json:"-"`
+
+	// The actual start time of the event.
+	StartTime *time.Time `json:"-"`
+
+	// The actual completion time of the event.
+	CompleteTime *time.Time `json:"-"`
 }
 
 // EventAction constants start with Action and include all known Linode API Event Actions.
@@ -121,6 +140,7 @@ const (
 	ActionLinodeMigrateDatacenterCreate           EventAction = "linode_migrate_datacenter_create"
 	ActionLinodeMutate                            EventAction = "linode_mutate"
 	ActionLinodeMutateCreate                      EventAction = "linode_mutate_create"
+	ActionLinodePowerOffOn                        EventAction = "linode_poweroff_on"
 	ActionLinodeReboot                            EventAction = "linode_reboot"
 	ActionLinodeRebuild                           EventAction = "linode_rebuild"
 	ActionLinodeResize                            EventAction = "linode_resize"
@@ -261,6 +281,7 @@ const (
 	EventNotification EventStatus = "notification"
 	EventScheduled    EventStatus = "scheduled"
 	EventStarted      EventStatus = "started"
+	EventCanceled     EventStatus = "canceled"
 )
 
 // EventEntity provides detailed information about the Event's
@@ -284,6 +305,9 @@ func (i *Event) UnmarshalJSON(b []byte) error {
 
 		Created       *parseabletime.ParseableTime `json:"created"`
 		TimeRemaining json.RawMessage              `json:"time_remaining"`
+		NotBefore     *parseabletime.ParseableTime `json:"not_before"`
+		StartTime     *parseabletime.ParseableTime `json:"start_time"`
+		CompleteTime  *parseabletime.ParseableTime `json:"complete_time"`
 	}{
 		Mask: (*Mask)(i),
 	}
@@ -294,6 +318,9 @@ func (i *Event) UnmarshalJSON(b []byte) error {
 
 	i.Created = (*time.Time)(p.Created)
 	i.TimeRemaining = duration.UnmarshalTimeRemaining(p.TimeRemaining)
+	i.NotBefore = (*time.Time)(p.NotBefore)
+	i.StartTime = (*time.Time)(p.StartTime)
+	i.CompleteTime = (*time.Time)(p.CompleteTime)
 
 	return nil
 }

account_maintenance.go

@@ -10,11 +10,22 @@ import (
 
 // AccountMaintenance represents a Maintenance object for any entity a user has permissions to view
 type AccountMaintenance struct {
-	Entity *Entity    `json:"entity"`
-	Reason string     `json:"reason"`
-	Status string     `json:"status"`
-	Type   string     `json:"type"`
-	When   *time.Time `json:"when"`
+	Entity *Entity `json:"entity"`
+	Reason string  `json:"reason"`
+	Status string  `json:"status"`
+	Type   string  `json:"type"`
+
+	// NOTE: MaintenancePolicySet can only be used with v4beta.
+	MaintenancePolicySet string `json:"maintenance_policy_set"`
+
+	Description  string     `json:"description"`
+	Source       string     `json:"source"`
+	NotBefore    *time.Time `json:"-"`
+	StartTime    *time.Time `json:"-"`
+	CompleteTime *time.Time `json:"-"`
+
+	// Deprecated: When is a deprecated property
+	When *time.Time `json:"when"`
 }
 
 // The entity being affected by maintenance
@@ -32,7 +43,10 @@ func (accountMaintenance *AccountMaintenance) UnmarshalJSON(b []byte) error {
 	p := struct {
 		*Mask
 
-		When *parseabletime.ParseableTime `json:"when"`
+		NotBefore    *parseabletime.ParseableTime `json:"not_before"`
+		StartTime    *parseabletime.ParseableTime `json:"start_time"`
+		CompleteTime *parseabletime.ParseableTime `json:"complete_time"`
+		When         *parseabletime.ParseableTime `json:"when"`
 	}{
 		Mask: (*Mask)(accountMaintenance),
 	}
@@ -41,6 +55,9 @@ func (accountMaintenance *AccountMaintenance) UnmarshalJSON(b []byte) error {
 		return err
 	}
 
+	accountMaintenance.NotBefore = (*time.Time)(p.NotBefore)
+	accountMaintenance.StartTime = (*time.Time)(p.StartTime)
+	accountMaintenance.CompleteTime = (*time.Time)(p.CompleteTime)
 	accountMaintenance.When = (*time.Time)(p.When)
 
 	return nil

account_notifications.go

@@ -44,16 +44,17 @@ type NotificationType string
 
 // NotificationType constants represent the actions that cause a Notification. New types may be added in the future.
 const (
-	NotificationMigrationScheduled NotificationType = "migration_scheduled"
-	NotificationMigrationImminent  NotificationType = "migration_imminent"
-	NotificationMigrationPending   NotificationType = "migration_pending"
-	NotificationRebootScheduled    NotificationType = "reboot_scheduled"
-	NotificationOutage             NotificationType = "outage"
-	NotificationPaymentDue         NotificationType = "payment_due"
-	NotificationTicketImportant    NotificationType = "ticket_important"
-	NotificationTicketAbuse        NotificationType = "ticket_abuse"
-	NotificationNotice             NotificationType = "notice"
-	NotificationMaintenance        NotificationType = "maintenance"
+	NotificationMigrationScheduled   NotificationType = "migration_scheduled"
+	NotificationMigrationImminent    NotificationType = "migration_imminent"
+	NotificationMigrationPending     NotificationType = "migration_pending"
+	NotificationRebootScheduled      NotificationType = "reboot_scheduled"
+	NotificationOutage               NotificationType = "outage"
+	NotificationPaymentDue           NotificationType = "payment_due"
+	NotificationTicketImportant      NotificationType = "ticket_important"
+	NotificationTicketAbuse          NotificationType = "ticket_abuse"
+	NotificationNotice               NotificationType = "notice"
+	NotificationMaintenance          NotificationType = "maintenance"
+	NotificationMaintenanceScheduled NotificationType = "maintenance_scheduled"
 )
 
 // ListNotifications gets a collection of Notification objects representing important,

account_settings.go

@@ -9,17 +9,21 @@ type AccountSettings struct {
 	// The default backups enrollment status for all new Linodes for all users on the account.  When enabled, backups are mandatory per instance.
 	BackupsEnabled bool `json:"backups_enabled"`
 
-	// Wether or not Linode Managed service is enabled for the account.
+	// Whether or not Linode Managed service is enabled for the account.
 	Managed bool `json:"managed"`
 
-	// Wether or not the Network Helper is enabled for all new Linode Instance Configs on the account.
+	// Whether or not the Network Helper is enabled for all new Linode Instance Configs on the account.
 	NetworkHelper bool `json:"network_helper"`
 
 	// A plan name like "longview-3"..."longview-100", or a nil value for to cancel any existing subscription plan.
 	LongviewSubscription *string `json:"longview_subscription"`
 
 	// A string like "disabled", "suspended", or "active" describing the status of this account’s Object Storage service enrollment.
 	ObjectStorage *string `json:"object_storage"`
+
+	// The slug of the maintenance policy associated with the account.
+	// NOTE: MaintenancePolicy can only be used with v4beta.
+	MaintenancePolicy string `json:"maintenance_policy"`
 }
 
 // AccountSettingsUpdateOptions are the updateable account wide flags or plans that effect new resources.
@@ -29,6 +33,10 @@ type AccountSettingsUpdateOptions struct {
 
 	// The default network helper setting for all new Linodes and Linode Configs for all users on the account.
 	NetworkHelper *bool `json:"network_helper,omitempty"`
+
+	// The slug of the maintenance policy to set the account to.
+	// NOTE: MaintenancePolicy can only be used with v4beta.
+	MaintenancePolicy *string `json:"maintenance_policy,omitempty"`
 }
 
 // GetAccountSettings gets the account wide flags or plans that effect new resources

go.work.sum

@@ -77,6 +77,9 @@ type Instance struct {
 
 	// Note: Linode interfaces may not currently be available to all users.
 	InterfaceGeneration InterfaceGeneration `json:"interface_generation"`
+
+	// NOTE: MaintenancePolicy can only be used with v4beta.
+	MaintenancePolicy string `json:"maintenance_policy"`
 }
 
 // InstanceSpec represents a linode spec
@@ -208,6 +211,9 @@ type InstanceCreateOptions struct {
 	Group string `json:"group,omitempty"`
 
 	IPv4 []string `json:"ipv4,omitempty"`
+
+	// NOTE: MaintenancePolicy can only be used with v4beta.
+	MaintenancePolicy *string `json:"maintenance_policy,omitempty"`
 }
 
 // InstanceCreatePlacementGroupOptions represents the placement group
@@ -227,6 +233,9 @@ type InstanceUpdateOptions struct {
 
 	// Deprecated: group is a deprecated property denoting a group label for the Linode.
 	Group *string `json:"group,omitempty"`
+
+	// NOTE: MaintenancePolicy can only be used with v4beta.
+	MaintenancePolicy *string `json:"maintenance_policy,omitempty"`
 }
 
 // UnmarshalJSON implements the json.Unmarshaler interface
@@ -276,12 +285,13 @@ func (backup *InstanceBackup) UnmarshalJSON(b []byte) error {
 // GetUpdateOptions converts an Instance to InstanceUpdateOptions for use in UpdateInstance
 func (i *Instance) GetUpdateOptions() InstanceUpdateOptions {
 	return InstanceUpdateOptions{
-		Label:           i.Label,
-		Group:           &i.Group,
-		Backups:         i.Backups,
-		Alerts:          i.Alerts,
-		WatchdogEnabled: &i.WatchdogEnabled,
-		Tags:            &i.Tags,
+		Label:             i.Label,
+		Group:             &i.Group,
+		Backups:           i.Backups,
+		Alerts:            i.Alerts,
+		WatchdogEnabled:   &i.WatchdogEnabled,
+		Tags:              &i.Tags,
+		MaintenancePolicy: &i.MaintenancePolicy,
 	}
 }
 

instances.go

@@ -0,0 +1,19 @@
+package linodego
+
+import (
+	"context"
+)
+
+type MaintenancePolicy struct {
+	Slug                  string `json:"slug"`
+	Label                 string `json:"label"`
+	Description           string `json:"description"`
+	Type                  string `json:"type"`
+	NotificationPeriodSec int    `json:"notification_period_sec"`
+	IsDefault             bool   `json:"is_default"`
+}
+
+// ListMaintenancePolicies can only be used with v4beta.
+func (c *Client) ListMaintenancePolicies(ctx context.Context, opts *ListOptions) ([]MaintenancePolicy, error) {
+	return getPaginatedResults[MaintenancePolicy](ctx, c, "maintenance/policies", opts)
+}

maintenance_policy.go

@@ -28,6 +28,7 @@ const (
 	CapabilityLinodes                       string = "Linodes"
 	CapabilityLkeHaControlPlanes            string = "LKE HA Control Planes"
 	CapabilityMachineImages                 string = "Machine Images"
+	CapabilityMaintenancePolicy             string = "Maintenance Policy"
 	CapabilityMetadata                      string = "Metadata"
 	CapabilityNodeBalancers                 string = "NodeBalancers"
 	CapabilityObjectStorage                 string = "Object Storage"

regions.go

@@ -51,13 +51,15 @@ func TestAccountSettings_Update(t *testing.T) {
 	defer httpmock.DeactivateAndReset()
 
 	opts := linodego.AccountSettingsUpdateOptions{
-		BackupsEnabled: Bool(false),
-		NetworkHelper:  Bool(false),
+		BackupsEnabled:    Bool(false),
+		NetworkHelper:     Bool(false),
+		MaintenancePolicy: String("linode/migrate"),
 	}
 
 	mockSettings := linodego.AccountSettings{
 		BackupsEnabled:       false,
 		NetworkHelper:        false,
+		MaintenancePolicy:    "linode/migrate",
 		LongviewSubscription: String("longview-100"),
 	}
 	mockResponse, _ := json.Marshal(mockSettings)
@@ -72,6 +74,7 @@ func TestAccountSettings_Update(t *testing.T) {
 	require.False(t, settings.NetworkHelper, "Expected NetworkHelper to be false")
 	require.NotNil(t, settings.LongviewSubscription, "Expected LongviewSubscription to be non-nil")
 	require.Equal(t, "longview-100", *settings.LongviewSubscription, "Expected LongviewSubscription to be 'longview-100'")
+	require.Equal(t, "linode/migrate", settings.MaintenancePolicy, "Expected MaintenancePolicy to be 'linode/migrate'")
 }
 
 func Bool(v bool) *bool       { return &v }

test/integration/account_settings_test.go

@@ -39,7 +39,7 @@ interactions:
       Content-Type:
       - application/json
       Expires:
-      - Wed, 30 Oct 2024 14:06:55 GMT
+      - Wed, 13 Aug 2025 16:42:52 GMT
       Pragma:
       - no-cache
       Strict-Transport-Security:
@@ -57,7 +57,7 @@ interactions:
       X-Oauth-Scopes:
       - unknown
       X-Ratelimit-Limit:
-      - "800"
+      - "1840"
       X-Xss-Protection:
       - 1; mode=block
     status: 200 OK