Skip to main content

Upgrade Plan

Upgrades the node to a larger plan (more vCPU / RAM / disk). The node must be powered off before issuing this request. The upgrade is destructive to the underlying VM but preserves the persistent root disk; transient state in RAM is lost.

PUT/api/v1/nodes/upgrade/{node_id}

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringoptional

    Region of the node being upgraded.

    • must be a non-empty string
    • should be a valid region identifier
    example{{location}}

Request body

application/json

object
planstringrequired

Plan SKU to upgrade to. The new plan must be larger than the current plan in at least one dimension (vCPU / RAM / disk). Use the plans API to discover valid SKUs.

exampleC3-2vCPU-2RAM-15DISK-C3.4GB_CHENNAI-Chennai
  • required
  • non-empty string
  • must follow the plan naming convention (alphanumeric, hyphens, periods)
  • must reference an existing plan in the node's region
imagestringrequired

OS image identifier to use after the upgrade. Usually the same as the node's current image - supplied explicitly so the new VM is reprovisioned from a known template.

exampleCentOS-7.5-Distro
  • required
  • non-empty string
  • allowed characters are letters, digits, hyphens, and periods

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the upgrade request.

example200
  • integer between 100 and 599
dataobject
errorsobject
messagestring

Human-readable status message for the upgrade.

exampleNode successfully upgraded
  • non-empty string
  • maximum length 255 characters