Endpoint

/v1/shutdown/reboot/status

GET

Retrieve the current status of the reboot manager.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "reboot_status",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "REBOOT_IDLE",
        "REBOOT_IN_PROGRESS",
        "REBOOT_PAUSED",
        "REBOOT_PAUSED_DUE_TO_ERROR"
      ],
      "description": "state:\n * `REBOOT_IDLE` - REBOOT_IDLE,\n * `REBOOT_IN_PROGRESS` - REBOOT_IN_PROGRESS,\n * `REBOOT_PAUSED` - REBOOT_PAUSED,\n * `REBOOT_PAUSED_DUE_TO_ERROR` - REBOOT_PAUSED_DUE_TO_ERROR"
    },
    "rolling": {
      "description": "rolling",
      "type": "boolean"
    },
    "upgrade_initiated": {
      "description": "upgrade_initiated",
      "type": "boolean"
    },
    "total_node_count": {
      "description": "total_node_count",
      "type": "number"
    },
    "rebooted_node_count": {
      "description": "rebooted_node_count",
      "type": "number"
    },
    "error_message": {
      "description": "error_message",
      "type": "string"
    }
  }
}