MaintenanceStatusResponseDto

Endpoints · All schemas

Field	Required	Description
action	Yes	See definition below
active	Yes	boolean
error	No	string
progress	No	integer
reason	No	Why the server is in maintenance, as set by the administrator (public)
task	No	string

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: MaintenanceAction

{
  "properties": {
    "action": {
      "$ref": "#/components/schemas/MaintenanceAction"
    },
    "active": {
      "type": "boolean"
    },
    "error": {
      "type": "string"
    },
    "progress": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "reason": {
      "description": "Why the server is in maintenance, as set by the administrator (public)",
      "type": "string"
    },
    "task": {
      "type": "string"
    }
  },
  "required": [
    "action",
    "active"
  ],
  "type": "object"
}