Load Balancer

Load Balancing distributes traffic across multiple servers according to predefined settings. By configuring traffic distribution appropriately for your environment, you can process traffic efficiently and maintain service continuity.

For more information about Load Balancing, see the Load Balancing service documentation.

APIs by resource

Select an API for key resources such as load balancers, listeners, and target groups to view its request details and response format.

Health monitors

Manages health checks.

API	Method	Path
Create health monitor	POST	/api/v1/load-balancers/health-monitors
Delete health monitor	DELETE	/api/v1/load-balancers/health-monitors/{health_monitor_id}
Get target group health check subnets	GET	/api/v1/load-balancers/target-groups/{target_group_id}/health-check-subnets
Get target group health monitor	GET	/api/v1/load-balancers/health-monitors/{health_monitor_id}
Update health monitor	PUT	/api/v1/load-balancers/health-monitors/{health_monitor_id}

High availability groups

Manages high availability groups.

API	Method	Path
Create HA group	POST	/api/v1/beyond-load-balancers
Delete HA group	DELETE	/api/v1/beyond-load-balancers/{beyond_load_balancer_id}
Detach HA group load balancer	DELETE	/api/v1/beyond-load-balancers/{beyond_load_balancer_id}/subnets/{load_balancer_id}
Get HA group	GET	/api/v1/beyond-load-balancers/{beyond_load_balancer_id}
List HA groups	GET	/api/v1/beyond-load-balancers
Update HA group	PUT	/api/v1/beyond-load-balancers/{beyond_load_balancer_id}
Update HA group load balancer	POST	/api/v1/beyond-load-balancers/{beyond_load_balancer_id}/subnets

L7 policies

Manages L7 policies.

API	Method	Path
Create L7 policy	POST	/api/v1/load-balancers/l7policies
Delete L7 policy	DELETE	/api/v1/load-balancers/l7policies/{l7policy_id}
Get L7 policy	GET	/api/v1/load-balancers/l7policies/{l7policy_id}
List L7 policies	GET	/api/v1/load-balancers/{load_balancer_id}/listeners/{listener_id}/l7policies
Update L7 policy	PUT	/api/v1/load-balancers/l7policies/{l7policy_id}

L7 rules

Manages L7 policy rules.

API	Method	Path
Add L7 policy rule	POST	/api/v1/load-balancers/l7policies/{l7policy_id}/rules
Delete L7 policy rule	DELETE	/api/v1/load-balancers/l7policies/{l7policy_id}/rules/{l7rule_id}
Get L7 policy rule	GET	/api/v1/load-balancers/l7policies/{l7policy_id}/rules/{l7rule_id}
List L7 policy rules	GET	/api/v1/load-balancers/l7policies/{l7policy_id}/rules
Update L7 policy rule	PUT	/api/v1/load-balancers/l7policies/{l7policy_id}/rules/{l7rule_id}

Listeners

Manages listeners.

API	Method	Path
Create listener	POST	/api/v1/load-balancers/listeners
Delete listener	DELETE	/api/v1/load-balancers/listeners/{listener_id}
Get listener	GET	/api/v1/load-balancers/listeners/{listener_id}
List listeners	GET	/api/v1/load-balancers/listeners
Update listener	PUT	/api/v1/load-balancers/listeners/{listener_id}

Load balancers

Manages load balancers and related settings.

API	Method	Path
Associate new public IP	POST	/api/v1/load-balancers/{load_balancer_id}/public-ips
Associate public IP	PUT	/api/v1/load-balancers/{load_balancer_id}/public-ips/{public_ip_id}
Create load balancer	POST	/api/v1/load-balancers
Delete load balancer	DELETE	/api/v1/load-balancers/{load_balancer_id}
Get load balancer	GET	/api/v1/load-balancers/{load_balancer_id}
List availability zones	GET	/api/v1/load-balancers/availability-zones
List load balancer types	GET	/api/v1/load-balancers/flavors
List load balancers	GET	/api/v1/load-balancers
List TLS certificates	GET	/api/v1/load-balancers/secrets
Remove public IP	DELETE	/api/v1/load-balancers/{load_balancer_id}/public-ips
Update access log	PATCH	/api/v1/load-balancers/{load_balancer_id}/access-log
Update load balancer	PUT	/api/v1/load-balancers/{load_balancer_id}

Target groups

Manages target groups and targets.

API	Method	Path
Add target	POST	/api/v1/load-balancers/target-groups/{target_group_id}/members
Create target group	POST	/api/v1/load-balancers/target-groups
Delete target group	DELETE	/api/v1/load-balancers/target-groups/{target_group_id}
Get target	GET	/api/v1/load-balancers/target-groups/{target_group_id}/members/{member_id}
Get target group	GET	/api/v1/load-balancers/target-groups/{target_group_id}
List target groups	GET	/api/v1/load-balancers/target-groups
List targets in target group	GET	/api/v1/load-balancers/target-groups/{target_group_id}/members
Remove target	DELETE	/api/v1/load-balancers/target-groups/{target_group_id}/members/{member_id}
Update target	PUT	/api/v1/load-balancers/target-groups/{target_group_id}/members/{member_id}
Update target group	PUT	/api/v1/load-balancers/target-groups/{target_group_id}
Update targets	PUT	/api/v1/load-balancers/target-groups/{target_group_id}/members