maintenances
Creates, updates, deletes, gets or lists a maintenances resource.
Overview​
| Name | maintenances |
| Type | Resource |
| Id | linode.account.maintenances |
Fields​
The following fields are returned by SELECT queries:
- list
Returns a paginated list of Maintenance objects.
| Name | Datatype | Description |
|---|---|---|
complete_time | string (date-time) | Beta, Filterable The time the maintenance completed. This field is filterable based on these parameters: - A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value. - Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs. (example: 2020-07-09T00:01:01) |
description | string | Beta Differentiates between scheduled and emergency maintenance. (Scheduled Maintenance, Emergency Maintenance) (example: Scheduled Maintenance) |
entity | object | The entity affected by the maintenance. |
maintenance_policy_set | string | Beta, Filterable The maintenance policy configured by the user. (example: linode/migrate) |
not_before | string (date-time) | Beta, Filterable The earliest time when the maintenance can start. This field is filterable based on these parameters: - A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value. - Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs. (example: 2020-07-09T00:01:01) |
reason | string | The reason maintenance is being performed. (example: This maintenance will allow us to update the BIOS on the host's motherboard.) |
source | string | Beta The origin of the maintenance. A platform source indicates that the maintenance was initiated by Akamai. A user source indicates that the maintenance was initiated by the user. (platform, user) (example: platform) |
start_time | string (date-time) | Beta, Filterable The time the maintenance started. This field is filterable based on these parameters: - A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value. - Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs. (example: 2020-07-09T00:01:01) |
status | string | Filterable The maintenance status. Maintenance progress follows the sequence pending, scheduled, started, and completed. A scheduled status is unique to Linodes that require a reboot for QEMU maintenance. (pending, scheduled, started, in-progress, completed, canceled) (example: started) |
type | string | Filterable The type of maintenance. (reboot, cold_migration, live_migration, migrate, power_off_on) (example: reboot) |
when | string (date-time) | Filterable The start time for the maintenance. This field is filterable based on these parameters: - A single ISO 8601 timestamp (yyyy-mm-ddThh:mm:ss), which returns only matches for that value. - Pairs of operator string keys (+or, +gt, +gte, +lt, +lte, or +neq) and single ISO 8601 timestamp. The +or operator accepts an array of values that can consist of single date-time strings or dictionaries of inequality operator pairs. (example: 2020-07-09T00:01:01) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | Returns maintenance information for any entity your user has permissions to view. If a maintenance object has been canceled, it's not returned. > 📘 > > Currently, only Linodes are included as entities for viewing. 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.
| Name | Datatype | Description |
|---|
SELECT examples​
- list
Returns maintenance information for any entity your user has permissions to view. If a maintenance object has been canceled, it's not returned.
> 📘
>
> Currently, only Linodes are included as entities for viewing.
Learn more...
SELECT
complete_time,
description,
entity,
maintenance_policy_set,
not_before,
reason,
source,
start_time,
status,
type,
when
FROM linode.account.maintenances
;