Endpoint

/v2/upgrade/prepare

POST

Prepare for upgrade.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_upgrade_prepare_request",
  "type": "object",
  "properties": {
    "image_path": {
      "description": "Path to image to install",
      "type": "string"
    },
    "auto_commit": {
      "description": "If true, the system will automatically commit when prepare is complete",
      "type": "boolean"
    },
    "do_rolling_reboot": {
      "description": "If true, do a rolling reboot after the upgrade is committed if doing a full platform upgrade",
      "type": "boolean"
    },
    "num_nodes_to_reboot": {
      "description": "If the number of nodes to reboot is configured and rolling reboot is enabled, your cluster reboots the specified number of nodes at a time. The number of nodes must be greater than 0 and less than or equal to the number of node failures that your cluster permits. By default, the value is the number of permitted node failures minus 1 (1 node minimum).",
      "type": "number"
    }
  }
}

Response

Codes

Code Description
202 Return value on success