Load Balancer Rule

Load balancer rules distribute inbound traffic on a public IP/port across backend instances.

Resource base path: /restapi/loadbalancerrule

Method	Path	Description
POST	/restapi/loadbalancerrule/createLoadBalancerRule	Create Load Balancer Rule
GET	/restapi/loadbalancerrule/loadBalancerRuleList	Load Balancer Rule List
PUT	/restapi/loadbalancerrule/updateLoadBalancerRule	Update Load Balancer Rule
DELETE	/restapi/loadbalancerrule/deleteLoadBalancerRule/{uuid}	Delete Load Balancer Rule

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Create Load Balancer Rule

Create Load Balancer Rule.

POST /restapi/loadbalancerrule/createLoadBalancerRule

Request body

Field	Type	Required	Description
privateport	string	No	Backend (private) port.
stickinessPolicyUuid	string	No
name	string	No	Name of the resource.
publicIpUuid	string	No
publicport	string	No	Public-facing port.
networkUuid	string	No	UUID of the network.
algorithm	string	No	Load balancer algorithm (source, roundrobin, leastconn) Example: roundrobin
kongLbSticky	object	No

{
  "privateport": "8080",
  "stickinessPolicyUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "example-name",
  "publicIpUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publicport": "8080",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "algorithm": "roundrobin",
  "kongLbSticky": {
    "stickyHoldTime": "string",
    "stickinessMethod": "None",
    "stickinessName": "example-name",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cookieName": "example-name"
  }
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/loadbalancerrule/createLoadBalancerRule" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "privateport": "8080",
  "stickinessPolicyUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "example-name",
  "publicIpUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publicport": "8080",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "algorithm": "roundrobin",
  "kongLbSticky": {
    "stickyHoldTime": "string",
    "stickinessMethod": "None",
    "stickinessName": "example-name",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cookieName": "example-name"
  }
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listLoadBalancerRuleResponse": [
    {
      "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "stickinessName": "example-name",
      "privatePort": "8080",
      "name": "example-name",
      "publicPort": "8080",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "algorithm": "roundrobin",
      "status": "Active"
    }
  ],
  "count": 1
}

---

Load Balancer Rule List

Load Balancer Rule List.

GET /restapi/loadbalancerrule/loadBalancerRuleList

Parameters

Parameter	In	Type	Required	Description
zoneUuid	query	string	✅ Yes	UUID of the zone the resource belongs to.
uuid	query	string	No	UUID of the resource.
ipAddressUuid	query	string	No	UUID of the public IP address.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/loadbalancerrule/loadBalancerRuleList?zoneUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listLoadBalancerRuleResponse": [
    {
      "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "stickinessName": "example-name",
      "privatePort": "8080",
      "name": "example-name",
      "publicPort": "8080",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "algorithm": "roundrobin",
      "status": "Active"
    }
  ],
  "count": 1
}

---

Update Load Balancer Rule

Update Load Balancer Rule.

PUT /restapi/loadbalancerrule/updateLoadBalancerRule

Request body

Field	Type	Required	Description
name	string	No	Name of the resource.
uuid	string	No	UUID of the resource.
algorithm	string	No	Load balancer algorithm (source, roundrobin, leastconn) Example: roundrobin

{
  "name": "example-name",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "algorithm": "roundrobin"
}

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/loadbalancerrule/updateLoadBalancerRule" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "algorithm": "roundrobin"
}'

Responses

Code	Description
200	Successful operation.
202	Accepted — processed asynchronously (poll via the Resource API Status endpoint).
401	Invalid authentication credentials.
550	Permission denied.

{
  "listLoadBalancerRuleResponse": [
    {
      "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "stickinessName": "example-name",
      "privatePort": "8080",
      "name": "example-name",
      "publicPort": "8080",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "state": "Running",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "algorithm": "roundrobin",
      "status": "Active"
    }
  ],
  "count": 1
}

---

Delete Load Balancer Rule

Delete Load Balancer Rule.

DELETE /restapi/loadbalancerrule/deleteLoadBalancerRule/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/loadbalancerrule/deleteLoadBalancerRule/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

true