View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Account

Maintenance List

get
https://api.linode.com/v4/account/maintenance

Returns a collection of Maintenance objects for any entity a user has permissions to view. Canceled Maintenance objects are not returned.

Currently, Linodes are the only entities available for viewing.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/account/maintenance

Response Samples

{
  "data": [
    {
      "entity": {
        "id": 1234,
        "label": "demo-linode",
        "type": "Linode",
        "url": "https://api.linode.com/v4/linode/instances/{linodeId}"
      },
      "status": "started",
      "type": "reboot",
      "reason": "This maintenance will allow us to update the BIOS on the host's motherboard.",
      "when": "2020-07-09T00:01:01.000Z"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: Returns a paginated list of Maintenance objects.

data
array of objects
entity
object

The entity being affected by maintenance.

id
number

The id of the entity being affected by maintenance.

label
string

The label of the entity being affected by maintenance.

type
string

The type of entity.

url
string

The API endpoint prefix to use in combination with the entity id to find specific information about the entity.

status
Filterable
string
Enum: "completed""pending""started"

The maintenance status.

Maintenance progresses in the following sequence: pending, started, then completed.

type
Filterable
string
Enum: "reboot""cold_migration""live_migration"

The type of maintenance.

reason
string

The reason maintenance is being performed.

when
Filterable
string

When the maintenance will begin.

Filterable with the following parameters:

  • A single value in date-time string format ("%Y-%m-%dT%H:%M:%S"), which returns only matches to that value.

  • A dictionary containing pairs of inequality operator string keys ("+or", "+gt", "+gte", "+lt", "+lte", or "+neq") and single date-time string format values ("%Y-%m-%dT%H:%M:%S"). "+or" accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.

page
integer

The current page.

pages
integer

The total number of pages.

results
integer

The total number of results.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.