Load Balancer
The main Load Balancer object. A Scaleway Load Balancer is a representation of a fully-managed, highly-available Instance configured to direct traffic across multiple servers. Use the Load Balancer endpoint to create, list, manage, update, and delete Load Balancers.
List Load Balancers
List all Load Balancers in the specified zone, for a Scaleway Organization or Scaleway Project. By default, the Load Balancers returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
zoneThe zone you want to target
query Parameters
nameLoad Balancer name to filter for.
order_bySort order of Load Balancers in the response.
page_sizeNumber of Load Balancers to return.
pagePage number to return, from the paginated results.
organization_idOrganization ID to filter for, only Load Balancers from this Organization will be returned.
project_idProject ID to filter for, only Load Balancers from this Project will be returned.
tagsFilter by tag, only Load Balancers with one or more matching tags will be returned.
lb_idsFilter by lb_ids, only Load Balancers with these IDs will be returned.
List Load Balancers › Responses
List of Load Balancer objects.
total_countThe total number of Load Balancer objects.
Create a Load Balancer
Create a new Load Balancer. Note that the Load Balancer will be created without frontends or backends; these must be created separately via the dedicated endpoints.
path Parameters
zoneThe zone you want to target
Create a Load Balancer › Request Body
nameName for the Load Balancer.
project_idScaleway Project to create the Load Balancer in.
descriptionDescription for the Load Balancer.
assign_flexible_ipDefines whether to automatically assign a flexible public IP to the Load Balancer. Default value is true (assign).
assign_flexible_ipv6Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. Default value is false (do not assign).
ip_idsList of IP IDs to attach to the Load Balancer.
tagsList of tags for the Load Balancer.
typeLoad Balancer commercial offer type. Use the Load Balancer types endpoint to retrieve a list of available offer types.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems (>= TLS1.2). Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility (= TLS1.3). Old is compatible with a small number of very old clients and should be used only as a last resort (>= TLS1.0).
organization_idScaleway Organization to create the Load Balancer in.
ip_idID of an existing flexible IP address to attach to the Load Balancer.
Create a Load Balancer › Responses
idUnderlying Instance ID.
nameLoad Balancer name.
descriptionLoad Balancer description.
statusLoad Balancer status.
List of underlying Instances.
organization_idScaleway Organization ID.
project_idScaleway Project ID.
List of IP addresses attached to the Load Balancer.
tagsLoad Balancer tags.
frontend_countNumber of frontends the Load Balancer has.
backend_countNumber of backends the Load Balancer has.
typeLoad Balancer offer type.
Subscriber information.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on client side.
created_atDate on which the Load Balancer was created. (RFC 3339 format)
updated_atDate on which the Load Balancer was last updated. (RFC 3339 format)
private_network_countNumber of Private Networks attached to the Load Balancer.
route_countNumber of routes configured on the Load Balancer.
zoneThe zone the Load Balancer is in.
regionThe region the Load Balancer is in.
Get a Load Balancer
Retrieve information about an existing Load Balancer, specified by its Load Balancer ID. Its full details, including name, status and IP address, are returned in the response object.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
Get a Load Balancer › Responses
idUnderlying Instance ID.
nameLoad Balancer name.
descriptionLoad Balancer description.
statusLoad Balancer status.
List of underlying Instances.
organization_idScaleway Organization ID.
project_idScaleway Project ID.
List of IP addresses attached to the Load Balancer.
tagsLoad Balancer tags.
frontend_countNumber of frontends the Load Balancer has.
backend_countNumber of backends the Load Balancer has.
typeLoad Balancer offer type.
Subscriber information.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on client side.
created_atDate on which the Load Balancer was created. (RFC 3339 format)
updated_atDate on which the Load Balancer was last updated. (RFC 3339 format)
private_network_countNumber of Private Networks attached to the Load Balancer.
route_countNumber of routes configured on the Load Balancer.
zoneThe zone the Load Balancer is in.
regionThe region the Load Balancer is in.
Update a Load Balancer
Update the parameters of an existing Load Balancer, specified by its Load Balancer ID. Note that the request type is PUT and not PATCH. You must set all parameters.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
Update a Load Balancer › Request Body
nameLoad Balancer name.
descriptionLoad Balancer description.
tagsList of tags for the Load Balancer.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems (>= TLS1.2). Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility (= TLS1.3). Old is compatible with a small number of very old clients and should be used only as a last resort (>= TLS1.0).
Update a Load Balancer › Responses
idUnderlying Instance ID.
nameLoad Balancer name.
descriptionLoad Balancer description.
statusLoad Balancer status.
List of underlying Instances.
organization_idScaleway Organization ID.
project_idScaleway Project ID.
List of IP addresses attached to the Load Balancer.
tagsLoad Balancer tags.
frontend_countNumber of frontends the Load Balancer has.
backend_countNumber of backends the Load Balancer has.
typeLoad Balancer offer type.
Subscriber information.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on client side.
created_atDate on which the Load Balancer was created. (RFC 3339 format)
updated_atDate on which the Load Balancer was last updated. (RFC 3339 format)
private_network_countNumber of Private Networks attached to the Load Balancer.
route_countNumber of routes configured on the Load Balancer.
zoneThe zone the Load Balancer is in.
regionThe region the Load Balancer is in.
Delete a Load Balancer
Delete an existing Load Balancer, specified by its Load Balancer ID. Deleting a Load Balancer is permanent, and cannot be undone. The Load Balancer's flexible IP address can either be deleted with the Load Balancer, or kept in your account for future use.
path Parameters
zoneThe zone you want to target
lb_idID of the Load Balancer to delete.
query Parameters
release_ipDefines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers.
Delete a Load Balancer › Responses
Migrate a Load Balancer
Migrate an existing Load Balancer from one commercial type to another. Allows you to scale your Load Balancer up or down in terms of bandwidth or multi-cloud provision.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
Migrate a Load Balancer › Request Body
typeLoad Balancer type to migrate to (use the List all Load Balancer offer types endpoint to get a list of available offer types).
Migrate a Load Balancer › Responses
idUnderlying Instance ID.
nameLoad Balancer name.
descriptionLoad Balancer description.
statusLoad Balancer status.
List of underlying Instances.
organization_idScaleway Organization ID.
project_idScaleway Project ID.
List of IP addresses attached to the Load Balancer.
tagsLoad Balancer tags.
frontend_countNumber of frontends the Load Balancer has.
backend_countNumber of backends the Load Balancer has.
typeLoad Balancer offer type.
Subscriber information.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on client side.
created_atDate on which the Load Balancer was created. (RFC 3339 format)
updated_atDate on which the Load Balancer was last updated. (RFC 3339 format)
private_network_countNumber of Private Networks attached to the Load Balancer.
route_countNumber of routes configured on the Load Balancer.
zoneThe zone the Load Balancer is in.
regionThe region the Load Balancer is in.