The Private Network object. It represents Scaleway Private Networks which can be attached to/detached from a Load Balancer. Use this endpoint to list the Private Networks attached to a Load Balancer, and to attach/detach a Load Balancer to/from a Private Network. To create new Private Networks, use the dedicated Private Networks APIOpen in new context.
Attach a Load Balancer to a Private Network
Attach a specified Load Balancer to a specified Private Network, defining a static or DHCP configuration for the Load Balancer on the network.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
Attach a Load Balancer to a Private Network › Request Body
private_network_idPrivate Network ID.
ipam_idsIPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network. (UUID format)
Attach a Load Balancer to a Private Network › Responses
Load Balancer object which is attached to the Private Network.
ipam_idsIPAM IDs of the booked IP addresses. (UUID format)
private_network_idPrivate Network ID.
statusStatus of Private Network connection.
created_atDate on which the Private Network was created. (RFC 3339 format)
updated_atDate on which the PN was last updated. (RFC 3339 format)
Object containing an array of a local IP address for the Load Balancer on this Private Network.
Object containing DHCP-assigned IP addresses.
Detach Load Balancer from Private Network
Detach a specified Load Balancer from a specified Private Network.
path Parameters
zoneThe zone you want to target
lb_idLoad balancer ID.
Detach Load Balancer from Private Network › Request Body
private_network_idSet your instance private network id.
Detach Load Balancer from Private Network › Responses
List Private Networks attached to a Load Balancer
List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
query Parameters
order_bySort order of Private Network objects in the response.
page_sizeNumber of objects to return.
pageThe page number to return, from the paginated results.
List Private Networks attached to a Load Balancer › Responses
List of Private Network objects attached to the Load Balancer.
total_countTotal number of objects in the response.