Update Committed Settings / Change Committed Settings

POST

/api/v1/update_committed_node_status/

curl --request POST \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/update_committed_node_status/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '"{\n    \"vcn_id\": {{node_id}},\n    // \"node_status\": \"auto_renew\",\n    \"node_status\": \"hourly_billing\",\n    // \"node_status\": \"auto_terminate\",\n    \"committed_plan\": 318\n}"'

import requests

response = requests.post(
    "https://api.e2enetworks.com/myaccount/api/v1/update_committed_node_status/",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json="{\n    \"vcn_id\": {{node_id}},\n    // \"node_status\": \"auto_renew\",\n    \"node_status\": \"hourly_billing\",\n    // \"node_status\": \"auto_terminate\",\n    \"committed_plan\": 318\n}",
)
print(response.json())

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

const response = await fetch(url, {
  method: "POST",
  headers: { "Authorization": "Bearer <API_TOKEN>", "Content-Type": "application/json" },
  body: JSON.stringify("{\n    \"vcn_id\": {{node_id}},\n    // \"node_status\": \"auto_renew\",\n    \"node_status\": \"hourly_billing\",\n    // \"node_status\": \"auto_terminate\",\n    \"committed_plan\": 318\n}"),
});
console.log(await response.json());

curl --request POST \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/update_committed_node_status/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vcn_id": 12345,
  "node_status": "hourly_billing",
  "committed_plan": ""
}'

import requests

response = requests.post(
    "https://api.e2enetworks.com/myaccount/api/v1/update_committed_node_status/",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "vcn_id": 12345,
        "node_status": "hourly_billing",
        "committed_plan": "",
    },
)
print(response.json())

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

const response = await fetch(url, {
  method: "POST",
  headers: { "Authorization": "Bearer <API_TOKEN>", "Content-Type": "application/json" },
  body: JSON.stringify({
    "vcn_id": 12345,
    "node_status": "hourly_billing",
    "committed_plan": ""
  }),
});
console.log(await response.json());

Changes the renewal behaviour of a committed load balancer node. Use node_status to switch between hourly billing, auto-renewal, and auto-termination at the end of the committed term. When node_status is auto_renew, committed_plan selects the term to renew into.

Update Committed Settings and Change Committed Settings share this request; the body you send decides which one runs.

Parameters

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

Location identifier for the settings update

Example

<LOCATION>

Request Body

application/json

One of:

string
object

JSON-formatted string with the payload to update committed settings

string

Example

{
    "vcn_id": {{node_id}},
    // "node_status": "auto_renew",
    "node_status": "hourly_billing",
    // "node_status": "auto_terminate",
    "committed_plan": 318
}

object

vcn_id

Identifier of the committed node/appliance whose settings are changing.

integer

Example

node_status

required

New billing/renewal behaviour. hourly_billing reverts to hourly, auto_renew renews into another committed term at expiry, and auto_terminate releases the node at expiry.

string

Allowed values: hourly_billing auto_renew auto_terminate

Example

hourly_billing

committed_plan

Committed term to renew into. Required when node_status is auto_renew.

string

Example

Responses

200

Successful response

application/json

object

status

HTTP status code of the update operation

integer

message

Status message indicating the result of the update operation

string

Example

{
  "status": 200,
  "message": "Updated Successfully"
}