Upgrade Plan

PUT

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

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/nodes/upgrade/{node_id}?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan": "C3-2vCPU-2RAM-15DISK-C3.4GB_CHENNAI-Chennai",
  "image": "CentOS-7.5-Distro"
}'

import requests

response = requests.put(
    "https://api.e2enetworks.com/myaccount/api/v1/nodes/upgrade/{node_id}",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "plan": "C3-2vCPU-2RAM-15DISK-C3.4GB_CHENNAI-Chennai",
        "image": "CentOS-7.5-Distro",
    },
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/nodes/upgrade/{node_id}");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", apikey: "<API_KEY>", location: "<LOCATION>" });

const response = await fetch(url, {
  method: "PUT",
  headers: { "Authorization": "Bearer <API_TOKEN>", "Content-Type": "application/json" },
  body: JSON.stringify({
    "plan": "C3-2vCPU-2RAM-15DISK-C3.4GB_CHENNAI-Chennai",
    "image": "CentOS-7.5-Distro"
  }),
});
console.log(await response.json());

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.

Parameters

Path Parameters

node_id

required

string

Path parameter node_id.

Query Parameters

project_id

required

integer

Identifier of the project to scope the request to. Required integer project ID.

Example

<PROJECT_ID>

apikey

required

string

API key used to authenticate the request

Example

<API_KEY>

location

required

string

Region of the node being upgraded.

Example

<LOCATION>

Request Body

application/json

object

plan

required

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.

string

Example

C3-2vCPU-2RAM-15DISK-C3.4GB_CHENNAI-Chennai

image

required

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.

string

Example

CentOS-7.5-Distro

Responses

200

Successful response

application/json

object

code

HTTP status code indicating the result of the upgrade request.

integer

data

object

vcpu

Number of virtual CPUs in the upgraded plan.

integer

ram

RAM allocation in megabytes.

integer

disk-size

Root disk size in megabytes.

integer

customer_id

Identifier of the customer that owns the node.

integer

vm_id

Identifier of the virtual machine.

integer

new_node_image_id

Identifier of the post-upgrade node image.

integer

old_node_image_id

Identifier of the pre-upgrade node image.

integer

action

Action identifier returned in the upgrade response.

string

cluster

Identifier of the target cluster. May be null when the node is not pinned to a specific cluster.

string

size

Size value returned by the upgrade response.

integer

location

Region/city name where the upgraded node lives.

string

errors

object

message

Human-readable status message for the upgrade.

string

Example

{
  "code": 200,
  "data": {
    "vcpu": 8,
    "ram": 16000,
    "disk-size": 143051,
    "customer_id": 12345,
    "vm_id": 12345,
    "new_node_image_id": 12345,
    "old_node_image_id": 12345,
    "action": "Delhi",
    "size": 0,
    "location": "Delhi"
  },
  "message": "Node successfully upgraded"
}