Network Load Balancer

A Network Load Balancer (NLB) is a Layer 4 (TCP/UDP) load balancer that distributes incoming traffic to Compute instances managed by an Instance Pool.

create-load-balancer

Create a Load Balancer

POST /load-balancer

Request body

Content-Type: application/json

Property	Type	Required	Description
`name`	string	yes	Load Balancer name Min length: `1`. Max length: `255`.
`description`	string	no	Load Balancer description Max length: `255`.
`labels`	object	no	Load balancer labels

Example

{
  "description": "string",
  "labels": {},
  "name": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-load-balancer: golang | Python | Java

CLI: exo api create-load-balancer

get-load-balancer

Retrieve Load Balancer details

GET /load-balancer/{id}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`created-at`	string	Load Balancer creation date ISO 8601 date-time.
`description`	string	Load Balancer description Max length: `255`.
`id`	string	Load Balancer ID Must be a valid UUID.
`ip`	string	Load Balancer public IP Must be a valid IPv4 address.
`labels`	object	Load Balancer Labels
`name`	string	Load Balancer name Min length: `1`. Max length: `255`.
`services`	array of Load Balancer Service	Load Balancer Services
`state`	string	Load Balancer state Allowed values: `creating`, `migrated`, `deleting`, `running`, `migrating`, `error`.

Example output

{
  "created-at": "2024-01-01T12:00:00Z",
  "description": "string",
  "id": "string",
  "ip": "string",
  "labels": {},
  "name": "string",
  "services": [
    {
      "description": "string",
      "healthcheck": {
        "interval": 0,
        "mode": "tcp",
        "port": 0,
        "retries": 0,
        "timeout": 0,
        "tls-sni": "string",
        "uri": "string"
      },
      "healthcheck-status": [
        {
          "public-ip": "string",
          "status": "failure"
        }
      ],
      "id": "string",
      "instance-pool": {
        "anti-affinity-groups": [
          {
            "id": null
          }
        ],
        "application-consistent-snapshot-enabled": true,
        "deploy-target": {
          "id": "string"
        },
        "description": "string",
        "disk-size": 0,
        "elastic-ips": [
          {
            "id": null
          }
        ],
        "id": "string",
        "instance-prefix": "string",
        "instance-type": {
          "id": "string"
        },
        "instances": [
          {
            "id": null
          }
        ],
        "ipv6-enabled": true,
        "labels": {},
        "manager": {
          "id": "string",
          "type": "sks-nodepool"
        },
        "min-available": 0,
        "name": "string",
        "private-networks": [
          {
            "id": null
          }
        ],
        "public-ip-assignment": "inet4",
        "security-groups": [
          {
            "id": null
          }
        ],
        "size": 0,
        "ssh-key": {
          "name": "string"
        },
        "ssh-keys": [
          {
            "name": null
          }
        ],
        "state": "scaling-up",
        "template": {
          "id": "string"
        },
        "user-data": "string"
      },
      "name": "string",
      "port": 0,
      "protocol": "tcp",
      "state": "creating",
      "strategy": "round-robin",
      "target-port": 0
    }
  ],
  "state": "creating"
}

SDK reference for get-load-balancer: golang | Python | Java

CLI: exo api get-load-balancer

update-load-balancer

Update a Load Balancer

PUT /load-balancer/{id}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Request body

Content-Type: application/json

Property	Type	Required	Description
`description`	string	no	Load Balancer description Max length: `255`.
`labels`	object	no
`name`	string	no	Load Balancer name Min length: `1`. Max length: `255`.

Example

{
  "description": "string",
  "labels": {},
  "name": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for update-load-balancer: golang | Python | Java

CLI: exo api update-load-balancer

delete-load-balancer

Delete a Load Balancer

DELETE /load-balancer/{id}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-load-balancer: golang | Python | Java

CLI: exo api delete-load-balancer

get-load-balancer-service

Retrieve Load Balancer Service details

GET /load-balancer/{id}/service/{service-id}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.
`service-id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`description`	string	Load Balancer Service description Max length: `255`.
`healthcheck`	Load Balancer Service healthcheck	Healthcheck configuration
`healthcheck-status`	array of Load Balancer Service status	Healthcheck status per backend server
`id`	string	Load Balancer Service ID Must be a valid UUID.
`instance-pool`	Instance Pool	Instance Pool to forward network traffic to
`name`	string	Load Balancer Service name Min length: `1`. Max length: `255`.
`port`	integer	Port exposed on the Load Balancer’s public IP Min: `0`.
`protocol`	string	Network traffic protocol Allowed values: `tcp`, `udp`.
`state`	string	Load Balancer Service state Allowed values: `creating`, `deleting`, `running`, `updating`, `error`.
`strategy`	string	Load balancing strategy Allowed values: `round-robin`, `maglev-hash`, `source-hash`.
`target-port`	integer	Port on which the network traffic will be forwarded to on the receiving instance Min: `0`.

Example output

{
  "description": "string",
  "healthcheck": {
    "interval": 0,
    "mode": "tcp",
    "port": 0,
    "retries": 0,
    "timeout": 0,
    "tls-sni": "string",
    "uri": "string"
  },
  "healthcheck-status": [
    {
      "public-ip": "string",
      "status": "failure"
    }
  ],
  "id": "string",
  "instance-pool": {
    "anti-affinity-groups": [
      {
        "id": "string"
      }
    ],
    "application-consistent-snapshot-enabled": true,
    "deploy-target": {
      "id": "string"
    },
    "description": "string",
    "disk-size": 0,
    "elastic-ips": [
      {
        "id": "string"
      }
    ],
    "id": "string",
    "instance-prefix": "string",
    "instance-type": {
      "id": "string"
    },
    "instances": [
      {
        "id": "string"
      }
    ],
    "ipv6-enabled": true,
    "labels": {},
    "manager": {
      "id": "string",
      "type": "sks-nodepool"
    },
    "min-available": 0,
    "name": "string",
    "private-networks": [
      {
        "id": "string"
      }
    ],
    "public-ip-assignment": "inet4",
    "security-groups": [
      {
        "id": "string"
      }
    ],
    "size": 0,
    "ssh-key": {
      "name": "string"
    },
    "ssh-keys": [
      {
        "name": "string"
      }
    ],
    "state": "scaling-up",
    "template": {
      "id": "string"
    },
    "user-data": "string"
  },
  "name": "string",
  "port": 0,
  "protocol": "tcp",
  "state": "creating",
  "strategy": "round-robin",
  "target-port": 0
}

SDK reference for get-load-balancer-service: golang | Python | Java

CLI: exo api get-load-balancer-service

update-load-balancer-service

Update a Load Balancer Service

PUT /load-balancer/{id}/service/{service-id}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.
`service-id`	`path`	Must be a valid UUID.

Request body

Content-Type: application/json

Property	Type	Required	Description
`description`	string	no	Load Balancer Service description Max length: `255`.
`healthcheck`	Load Balancer Service healthcheck	no	Healthcheck configuration
`name`	string	no	Load Balancer Service name Max length: `255`.
`port`	integer	no	Port exposed on the Load Balancer’s public IP Min: `1`. Max: `65535`.
`protocol`	string	no	Network traffic protocol Allowed values: `tcp`, `udp`.
`strategy`	string	no	Load balancing strategy Allowed values: `round-robin`, `maglev-hash`, `source-hash`.
`target-port`	integer	no	Port on which the network traffic will be forwarded to on the receiving instance Min: `1`. Max: `65535`.

Example

{
  "description": "string",
  "healthcheck": {
    "interval": 0,
    "mode": "tcp",
    "port": 0,
    "retries": 0,
    "timeout": 0,
    "tls-sni": "string",
    "uri": "string"
  },
  "name": "string",
  "port": 0,
  "protocol": "tcp",
  "strategy": "round-robin",
  "target-port": 0
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for update-load-balancer-service: golang | Python | Java

CLI: exo api update-load-balancer-service

delete-load-balancer-service

Delete a Load Balancer Service

DELETE /load-balancer/{id}/service/{service-id}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.
`service-id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-load-balancer-service: golang | Python | Java

CLI: exo api delete-load-balancer-service

Other Operations

reset-load-balancer-field

Reset a Load Balancer field to its default value

DELETE /load-balancer/{id}/{field}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.
`field`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for reset-load-balancer-field: golang | Python | Java

CLI: exo api reset-load-balancer-field

reset-load-balancer-service-field

Reset a Load Balancer Service field to its default value

DELETE /load-balancer/{id}/service/{service-id}/{field}

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.
`service-id`	`path`	Must be a valid UUID.
`field`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for reset-load-balancer-service-field: golang | Python | Java

CLI: exo api reset-load-balancer-service-field

list-load-balancers

List Load Balancers

GET /load-balancer

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`load-balancers`	array of Load Balancer

Example output

{
  "load-balancers": [
    {
      "created-at": "2024-01-01T12:00:00Z",
      "description": "string",
      "id": "string",
      "ip": "string",
      "labels": {},
      "name": "string",
      "services": [
        {
          "description": "string",
          "healthcheck": {
            "interval": null,
            "mode": null,
            "port": null,
            "retries": null,
            "timeout": null,
            "tls-sni": null,
            "uri": null
          },
          "healthcheck-status": [
            null
          ],
          "id": "string",
          "instance-pool": {
            "anti-affinity-groups": null,
            "application-consistent-snapshot-enabled": null,
            "deploy-target": null,
            "description": null,
            "disk-size": null,
            "elastic-ips": null,
            "id": null,
            "instance-prefix": null,
            "instance-type": null,
            "instances": null,
            "ipv6-enabled": null,
            "labels": null,
            "manager": null,
            "min-available": null,
            "name": null,
            "private-networks": null,
            "public-ip-assignment": null,
            "security-groups": null,
            "size": null,
            "ssh-key": null,
            "ssh-keys": null,
            "state": null,
            "template": null,
            "user-data": null
          },
          "name": "string",
          "port": 0,
          "protocol": "tcp",
          "state": "creating",
          "strategy": "round-robin",
          "target-port": 0
        }
      ],
      "state": "creating"
    }
  ]
}

SDK reference for list-load-balancers: golang | Python | Java

CLI: exo api list-load-balancers

add-service-to-load-balancer

Add a Load Balancer Service

POST /load-balancer/{id}/service

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Request body

Content-Type: application/json

Property	Type	Required	Description
`healthcheck`	Load Balancer Service healthcheck	yes	Healthcheck configuration
`instance-pool`	Instance Pool	yes	Instance Pool to forward traffic to
`name`	string	yes	Load Balancer Service name Min length: `1`. Max length: `255`.
`port`	integer	yes	Port exposed on the Load Balancer’s public IP Min: `1`. Max: `65535`.
`protocol`	string	yes	Network traffic protocol Allowed values: `tcp`, `udp`.
`strategy`	string	yes	Load balancing strategy Allowed values: `round-robin`, `maglev-hash`, `source-hash`.
`target-port`	integer	yes	Port on which the network traffic will be forwarded to on the receiving instance Min: `1`. Max: `65535`.
`description`	string	no	Load Balancer Service description Max length: `255`.

Example

{
  "description": "string",
  "healthcheck": {
    "interval": 0,
    "mode": "tcp",
    "port": 0,
    "retries": 0,
    "timeout": 0,
    "tls-sni": "string",
    "uri": "string"
  },
  "instance-pool": {
    "anti-affinity-groups": [
      {
        "id": "string"
      }
    ],
    "application-consistent-snapshot-enabled": true,
    "deploy-target": {
      "id": "string"
    },
    "description": "string",
    "disk-size": 0,
    "elastic-ips": [
      {
        "id": "string"
      }
    ],
    "id": "string",
    "instance-prefix": "string",
    "instance-type": {
      "id": "string"
    },
    "instances": [
      {
        "id": "string"
      }
    ],
    "ipv6-enabled": true,
    "labels": {},
    "manager": {
      "id": "string",
      "type": "sks-nodepool"
    },
    "min-available": 0,
    "name": "string",
    "private-networks": [
      {
        "id": "string"
      }
    ],
    "public-ip-assignment": "inet4",
    "security-groups": [
      {
        "id": "string"
      }
    ],
    "size": 0,
    "ssh-key": {
      "name": "string"
    },
    "ssh-keys": [
      {
        "name": "string"
      }
    ],
    "state": "scaling-up",
    "template": {
      "id": "string"
    },
    "user-data": "string"
  },
  "name": "string",
  "port": 0,
  "protocol": "tcp",
  "strategy": "round-robin",
  "target-port": 0
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for add-service-to-load-balancer: golang | Python | Java

CLI: exo api add-service-to-load-balancer

Last updated on May 29, 2026