Load Balancer

DELETE /network/load-balancer/health-checks

Delete health check policy

Delete a health check policy by ID

Request JSON Object:

  • id (string) – (required)

Status Codes:
POST /network/load-balancer/health-checks

Create health check policy

Create a health check policy on a load balancer rule

Request JSON Object:

  • description (string)

  • healthythreshold (integer) – default: 2

  • intervaltime (integer) – seconds, default: 5

  • lbruleid (string) – (required)

  • pingpath (string) – default: “/”

  • responsetimeout (integer) – seconds, default: 2

  • unhealthythreshold (integer) – default: 3

Status Codes:
PUT /network/load-balancer/health-checks

Update health check policy

Update an existing health check policy

Request JSON Object:

  • id (string) – (required)

Status Codes:
POST /network/load-balancer/health-checks/list

List health check policies

List health check policies for a load balancer rule

Request JSON Object:

  • lbruleid (string) – (required)

Status Codes:
DELETE /network/load-balancer/rules

Delete load balancer rule

Delete a load balancer rule by ID

Request JSON Object:

  • id (string) – (required)

Status Codes:
POST /network/load-balancer/rules

Create load balancer rule

Create a new load balancer rule on a public IP address

Request JSON Object:

  • account (string)

  • algorithm (string) – roundrobin | leastconn | source (required)

  • cidrlist[] (string)

  • description (string)

  • domainid (string)

  • name (string) – (required)

  • networkid (string)

  • openfirewall (boolean)

  • privateport (integer) – (required)

  • protocol (string) – tcp | udp | tcp-proxy (default: tcp)

  • publicipid (string) – (required)

  • publicport (integer) – (required)

  • zoneid (string)

Status Codes:
PUT /network/load-balancer/rules

Update load balancer rule

Update an existing load balancer rule

Request JSON Object:

  • algorithm (string) – roundrobin | leastconn | source

  • cidrlist[] (string)

  • description (string)

  • id (string) – (required)

  • name (string)

  • protocol (string)

Status Codes:
POST /network/load-balancer/rules/assign

Assign VMs to LB rule

Assign virtual machines to an existing load balancer rule

Request JSON Object:

  • id (string) – (required)

  • virtualmachineids[] (string)

  • vmidipmap (object)

Status Codes:
POST /network/load-balancer/rules/get-by-id

Get load balancer rule by ID

Retrieve a single load balancer rule by its ID

Status Codes:
POST /network/load-balancer/rules/get-by-name

Get load balancer rule by name

Retrieve a single load balancer rule by its name

Status Codes:
POST /network/load-balancer/rules/instances

List LB rule instances

List virtual machines assigned to a load balancer rule

Request JSON Object:

  • applied (boolean)

  • id (string) – LB rule ID (required)

  • lbvmips (boolean)

  • page (integer)

  • pagesize (integer)

Status Codes:
POST /network/load-balancer/rules/list

List load balancer rules

List load balancer rules with optional filters

Status Codes:
POST /network/load-balancer/rules/remove

Remove VMs from LB rule

Remove virtual machines from an existing load balancer rule

Request JSON Object:

  • id (string) – (required)

  • virtualmachineids[] (string)

  • vmidipmap (object)

Status Codes:
DELETE /network/load-balancer/stickiness

Delete stickiness policy

Delete a session persistence policy by ID

Request JSON Object:

  • id (string) – (required)

Status Codes:
POST /network/load-balancer/stickiness

Create stickiness policy

Create a session persistence policy on a load balancer rule (LbCookie, AppCookie, SourceBased)

Request JSON Object:

  • description (string)

  • lbruleid (string) – (required)

  • methodname (string) – LbCookie | AppCookie | SourceBased (required)

  • name (string) – (required)

  • params (object) – method-specific params (e.g., cookie-name, tablesize, expire)

Status Codes:
PUT /network/load-balancer/stickiness

Update stickiness policy

Update an existing session persistence policy

Request JSON Object:

  • id (string) – (required)

Status Codes:
POST /network/load-balancer/stickiness/list

List stickiness policies

List session persistence policies for a load balancer rule

Request JSON Object:

  • lbruleid (string) – (required)

Status Codes: