IP addresses

Download schema

The Load Balancer IP address object. It represents a flexible IP address which can be attached to a Load Balancer. Use this endpoint to create, list, get, update and delete your Load Balancer IP addresses.

List IP addresses

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/ips

List the Load Balancer flexible IP addresses held in the account (filtered by Organization ID or Project ID). It is also possible to search for a specific IP address.

List IP addresses › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

List IP addresses › query Parameters

page

integer · int32

The page number to return, from the paginated results.

page_size

integer · uint32

Number of IP addresses to return.

ip_address

string

IP address to filter for.

organization_id

string

Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned.

project_id

string

Project ID to filter for, only Load Balancer IP addresses from this Project will be returned.

ip_type

scaleway.lb.v1.ListIpsRequest.IpType · enum

IP type to filter for.

Enum values:

all

ipv4

ipv6

Default: all

tags

string[]

Tag to filter for, only IPs with one or more matching tags will be returned.

List IP addresses › Responses

200

scaleway.lb.v1.ListIpsResponse

scaleway.lb.v1.Ip[]

List of IP address objects.

total_count

integer · uint32

Total count of IP address objects, without pagination.

Create an IP address

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/ips

Create a new Load Balancer flexible IP address, in the specified Scaleway Project. This can be attached to new Load Balancers created in the future.

Create an IP address › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

Create an IP address › Request Body

project_id

string | null

Project ID of the Project where the IP address should be created.

reverse

string | null

Reverse DNS (domain name) for the IP address.

is_ipv6

boolean

If true, creates a Flexible IP with an ipv6 address.

tags

string[]

List of tags for the IP.

Create an IP address › Responses

200

scaleway.lb.v1.Ip

id

string

IP address ID.

ip_address

string

IP address.

organization_id

string

Organization ID of the Scaleway Organization the IP address is in.

project_id

string

Project ID of the Scaleway Project the IP address is in.

lb_id

string | null

Load Balancer ID.

reverse

string

Reverse DNS (domain name) of the IP address.

tags

string[]

IP tags.

zone

string

The zone the IP address is in.

Get an IP address

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/ips/{ip_id}

Retrieve the full details of a Load Balancer flexible IP address.

Get an IP address › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

ip_id

string · required

IP address ID.

Get an IP address › Responses

200

scaleway.lb.v1.Ip

id

string

IP address ID.

ip_address

string

IP address.

organization_id

string

Organization ID of the Scaleway Organization the IP address is in.

project_id

string

Project ID of the Scaleway Project the IP address is in.

lb_id

string | null

Load Balancer ID.

reverse

string

Reverse DNS (domain name) of the IP address.

tags

string[]

IP tags.

zone

string

The zone the IP address is in.

Update an IP address

PATCH

https://api.scaleway.com

/lb/v1/zones/{zone}/ips/{ip_id}

Update the reverse DNS of a Load Balancer flexible IP address.

Update an IP address › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

ip_id

string · required

IP address ID.

Update an IP address › Request Body

reverse

string | null

Reverse DNS (domain name) for the IP address.

lb_id

string | null

ID of the server on which to attach the flexible IP.

tags

array | null

List of tags for the IP.

Update an IP address › Responses

200

scaleway.lb.v1.Ip

id

string

IP address ID.

ip_address

string

IP address.

organization_id

string

Organization ID of the Scaleway Organization the IP address is in.

project_id

string

Project ID of the Scaleway Project the IP address is in.

lb_id

string | null

Load Balancer ID.

reverse

string

Reverse DNS (domain name) of the IP address.

tags

string[]

IP tags.

zone

string

The zone the IP address is in.

Delete an IP address

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/ips/{ip_id}

Delete a Load Balancer flexible IP address. This action is irreversible, and cannot be undone.

Delete an IP address › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

ip_id

string · required

IP address ID.

Delete an IP address › Responses

No data returned

Route Stats