Public, flexible IP addresses for Public Gateways, allowing the gateway to reach the public internet, as well as forward (masquerade) traffic from member devices of attached Private Networks.
List IPs
List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response.
path Parameters
zoneThe zone you want to target
query Parameters
order_byOrder in which to return results.
pagePage number.
page_sizeIP addresses per page.
organization_idInclude only gateways in this Organization. (UUID format)
project_idFilter for IP addresses in this Project. (UUID format)
tagsFilter for IP addresses with these tags.
reverseFilter for IP addresses that have a reverse containing this string.
is_freeFilter based on whether the IP is attached to a gateway or not.
List IPs › Responses
IP addresses on this page.
total_countTotal count of IP addresses matching the filter.
Reserve an IP
Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project.
path Parameters
zoneThe zone you want to target
Reserve an IP › Request Body
project_idProject to create the IP address in. (UUID format)
tagsTags to give to the IP address.
Reserve an IP › Responses
idIP address ID. (UUID format)
organization_idOwning Organization. (UUID format)
project_idOwning Project. (UUID format)
created_atIP address creation date. (RFC 3339 format)
updated_atIP address last modification date. (RFC 3339 format)
tagsTags associated with the IP address.
addressThe IP address itself. (IP address)
reverseReverse domain name for the IP address.
gateway_idPublic Gateway associated with the IP address. (UUID format)
zoneZone of the IP address.
Get an IP
Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata.
path Parameters
zoneThe zone you want to target
ip_idID of the IP address to get. (UUID format)
Get an IP › Responses
idIP address ID. (UUID format)
organization_idOwning Organization. (UUID format)
project_idOwning Project. (UUID format)
created_atIP address creation date. (RFC 3339 format)
updated_atIP address last modification date. (RFC 3339 format)
tagsTags associated with the IP address.
addressThe IP address itself. (IP address)
reverseReverse domain name for the IP address.
gateway_idPublic Gateway associated with the IP address. (UUID format)
zoneZone of the IP address.
Delete an IP
Delete a flexible IP address from your account. This action is irreversible.
path Parameters
zoneThe zone you want to target
ip_idID of the IP address to delete. (UUID format)
Delete an IP › Responses
Update an IP
Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to.
path Parameters
zoneThe zone you want to target
ip_idID of the IP address to update. (UUID format)
Update an IP › Request Body
tagsTags to give to the IP address.
reverseReverse to set on the address. Empty string to unset.
gateway_idGateway to attach the IP address to. Empty string to detach. (UUID format)
Update an IP › Responses
idIP address ID. (UUID format)
organization_idOwning Organization. (UUID format)
project_idOwning Project. (UUID format)
created_atIP address creation date. (RFC 3339 format)
updated_atIP address last modification date. (RFC 3339 format)
tagsTags associated with the IP address.
addressThe IP address itself. (IP address)
reverseReverse domain name for the IP address.
gateway_idPublic Gateway associated with the IP address. (UUID format)
zoneZone of the IP address.