Returns a collection of Maintenance objects for any entity a user has permissions to view. Cancelled Maintenance objects are not returned.
Currently, Linodes are the only entities available for viewing.
643 matches
100 actions
Linode
100 actions
Infrastructure/Linode
Returns a collection of Maintenance objects for any entity a user has permissions to view. Cancelled Maintenance objects are not returned.
Currently, Linodes are the only entities available for viewing.
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "Information about maintenance affecting an entity.\n",
"properties": {
"entity": {
"type": "object",
"description": "The entity being affected by maintenance.\n",
"properties": {
"id": {
"type": "number",
"description": "The id of the entity being affected by maintenance.\n"
},
"label": {
"type": "string",
"description": "The label of the entity being affected by maintenance.\n"
},
"type": {
"type": "string",
"description": "The type of entity.\n"
},
"url": {
"type": "string",
"description": "The API endpoint prefix to use in combination with the entity id to find specific information about the entity.\n"
}
}
},
"reason": {
"type": "string",
"description": "The reason maintenance is being performed.\n"
},
"status": {
"type": "string",
"description": "The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.\n",
"enum": [
"completed",
"pending",
"started"
]
},
"type": {
"type": "string",
"description": "The type of maintenance.\n",
"enum": [
"reboot",
"cold_migration",
"live_migration"
]
},
"when": {
"type": "string",
"format": "date-time",
"description": "When the maintenance will begin.\n\n[Filterable](/docs/api/#filtering-and-sorting) with the following parameters:\n\n* A single value in date-time string format (\"%Y-%m-%dT%H:%M:%S\"), which returns only matches to that value.\n\n* A dictionary containing pairs of inequality operator string keys (\"+or\", \"+gt\", \"+gte\", \"+lt\", \"+lte\",\nor \"+neq\") and single date-time string format values (\"%Y-%m-%dT%H:%M:%S\"). \"+or\" accepts an array of values that\nmay consist of single date-time strings or dictionaries of inequality operator pairs.\n"
}
}
}
},
"page": {
"type": "integer",
"description": "The current [page](/docs/api/#pagination)."
},
"pages": {
"type": "integer",
"description": "The total number of [pages](/docs/api/#pagination)."
},
"results": {
"type": "integer",
"description": "The total number of results."
}
}
}