IPs

Download schema

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

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/ips

List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response.

List IPs › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List IPs › query Parameters

order_by

scaleway.vpc_gw.v2.ListIPsRequest.OrderBy · enum

Order in which to return results.

Enum values:

created_at_asc

created_at_desc

address_asc

address_desc

reverse_asc

reverse_desc

Default: created_at_asc

page

integer · int32

Page number.

page_size

integer · uint32

IP addresses per page.

organization_id

string

Include only gateways in this Organization. (UUID format)

project_id

string

Filter for IP addresses in this Project. (UUID format)

tags

string[]

Filter for IP addresses with these tags.

reverse

string

Filter for IP addresses that have a reverse containing this string.

is_free

boolean

Filter based on whether the IP is attached to a gateway or not.

List IPs › Responses

200

scaleway.vpc_gw.v2.ListIPsResponse

scaleway.vpc_gw.v2.IP[]

IP addresses on this page.

total_count

integer · uint64

Total count of IP addresses matching the filter.

Reserve an IP

POST

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/ips

Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project.

Reserve an IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Reserve an IP › Request Body

project_id

string

Project to create the IP address in. (UUID format)

tags

string[]

Tags to give to the IP address.

Reserve an IP › Responses

200

scaleway.vpc_gw.v2.IP

id

string

IP address ID. (UUID format)

srn

string

The SRN of the ip.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

IP address creation date. (RFC 3339 format)

updated_at

string | null · date-time

IP address last modification date. (RFC 3339 format)

tags

string[]

Tags associated with the IP address.

address

string

The IP address itself. (IP address)

reverse

string | null

Reverse domain name for the IP address.

gateway_id

string | null

Public Gateway associated with the IP address. (UUID format)

zone

string

Zone of the IP address.

POST/vpc-gw/v2/zones/{zone}/ips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"6170692e-7363-616c-6577-61792e636f6d"}' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/ips"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "tags": [
    "string"
  ],
  "address": "1.2.3.4",
  "reverse": "reverse",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "zone": "zone"
}

json

application/json

Get an IP

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/ips/{ip_id}

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.

Get an IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip_id

string · required

ID of the IP address to get. (UUID format)

Get an IP › Responses

200

scaleway.vpc_gw.v2.IP

id

string

IP address ID. (UUID format)

srn

string

The SRN of the ip.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

IP address creation date. (RFC 3339 format)

updated_at

string | null · date-time

IP address last modification date. (RFC 3339 format)

tags

string[]

Tags associated with the IP address.

address

string

The IP address itself. (IP address)

reverse

string | null

Reverse domain name for the IP address.

gateway_id

string | null

Public Gateway associated with the IP address. (UUID format)

zone

string

Zone of the IP address.

Delete an IP

DELETE

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/ips/{ip_id}

Delete a flexible IP address from your account. This action is irreversible.

Delete an IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip_id

string · required

ID of the IP address to delete. (UUID format)

Delete an IP › Responses

No data returned

Update an IP

PATCH

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/ips/{ip_id}

Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to.

Update an IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip_id

string · required

ID of the IP address to update. (UUID format)

Update an IP › Request Body

tags

array | null

Tags to give to the IP address.

reverse

string | null

Reverse to set on the address. Empty string to unset.

gateway_id

string | null

Gateway to attach the IP address to. Empty string to detach. (UUID format)

Update an IP › Responses

200

scaleway.vpc_gw.v2.IP

id

string

IP address ID. (UUID format)

srn

string

The SRN of the ip.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

IP address creation date. (RFC 3339 format)

updated_at

string | null · date-time

IP address last modification date. (RFC 3339 format)

tags

string[]

Tags associated with the IP address.

address

string

The IP address itself. (IP address)

reverse

string | null

Reverse domain name for the IP address.

gateway_id

string | null

Public Gateway associated with the IP address. (UUID format)

zone

string

Zone of the IP address.

PATCH/vpc-gw/v2/zones/{zone}/ips/{ip_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/ips/{ip_id}"

Example Request Body

{
  "tags": [],
  "reverse": "reverse",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "tags": [
    "string"
  ],
  "address": "1.2.3.4",
  "reverse": "reverse",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "zone": "zone"
}

json

application/json

PAT Rules Gateway Types