Skip to main content

policies

Creates, updates, deletes, gets or lists a policies resource.

Overview

Namepolicies
TypeResource
Idlinode.maintenance.policies

Fields

The following fields are returned by SELECT queries:

Returns a paginated list of maintenance policy objects.

NameDatatypeDescription
descriptionstringA brief explanation of the maintenance policy's intended behavior. (example: Migrates the Linode to a new host while it remains fully operational. Recommended for maximizing availability.)
is_defaultbooleanIndicates whether this policy is the default one applied when creating a Linode.
labelstringThe display name for the maintenance policy. (example: Migrate)
notification_period_secintegerFilterable Number of seconds before the maintenance event triggers. A value of 0 means no prior notification.
slugstringUnique identifier for the maintenance policy. System policies are prefixed with linode/. (example: linode/migrate)
typestringThe type of policy. (migrate, power_off_on) (example: migrate)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectBeta List all available maintenance policies that can be applied to your Linodes.

> 📘
>
> This operation is beta and only works when using the beta API. Call the URL with the apiVersion path parameter set to v4beta.

Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription

SELECT examples

Beta List all available maintenance policies that can be applied to your Linodes.

> 📘
>
> This operation is beta and only works when using the beta API. Call the URL with the apiVersion path parameter set to v4beta.

Learn more...

SELECT
description,
is_default,
label,
notification_period_sec,
slug,
type
FROM linode.maintenance.policies
;