Internal LB

Internal load balancers for VPC tiers (private-side load balancing).

Resource base path: /restapi/internallb

Method	Path	Description
POST	/restapi/internallb/createInternalLb	Create Internal LB
GET	/restapi/internallb/internalLbList	Internal LB List
GET	/restapi/internallb/assignLbRule	Assign Internal LB
DELETE	/restapi/internallb/deleteInternalLb/{uuid}	Delete Internal LB

note

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

---

Create Internal LB

Create Internal LB.

POST /restapi/internallb/createInternalLb

Request body

Field	Type	Required	Description
sourceport	string	No
instanceport	string	No
name	string	No	Name of the resource.
description	string	No	Human-readable description.
sourceIpAddress	string	No
networkUuid	string	No	UUID of the network.
algorithm	string	✅ Yes	Internal Lb algorithm (source, roundrobin, leastconn) Example: roundrobin

{
  "sourceport": "8080",
  "instanceport": "8080",
  "name": "example-name",
  "description": "string",
  "sourceIpAddress": "string",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "algorithm": "roundrobin"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/internallb/createInternalLb" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sourceport": "8080",
  "instanceport": "8080",
  "name": "example-name",
  "description": "string",
  "sourceIpAddress": "string",
  "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "algorithm": "roundrobin"
}'

Responses

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

{
  "count": 1,
  "listInternalLbResponse": [
    {
      "instancePort": "8080",
      "sourcePort": "8080",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "sourceIpAddress": "string",
      "isActive": true,
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "algorithm": "roundrobin",
      "status": "Active"
    }
  ]
}

---

Internal LB List

Internal LB List.

GET /restapi/internallb/internalLbList

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.
networkUuid	query	string	No	UUID of the network.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/internallb/internalLbList?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.

{
  "count": 1,
  "listInternalLbResponse": [
    {
      "instancePort": "8080",
      "sourcePort": "8080",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "sourceIpAddress": "string",
      "isActive": true,
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "algorithm": "roundrobin",
      "status": "Active"
    }
  ]
}

---

Assign Internal LB

Assign Internal LB.

GET /restapi/internallb/assignLbRule

Parameters

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

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/internallb/assignLbRule?uuid=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.

{
  "count": 1,
  "listInternalLbResponse": [
    {
      "instancePort": "8080",
      "sourcePort": "8080",
      "name": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "sourceIpAddress": "string",
      "isActive": true,
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "algorithm": "roundrobin",
      "status": "Active"
    }
  ]
}

---

Delete Internal LB

Delete Internal LB.

DELETE /restapi/internallb/deleteInternalLb/{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/internallb/deleteInternalLb/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

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

true