IPs

Download schema

A flexible IP address is an IP address which you hold independently of any Instance. You can attach it to any of your Instances and do live migration of the IP address between your Instances.

Note that attaching a flexible IP address to an Instance removes its previous public IP and interrupts any ongoing public connection to the Instance. This does not apply if you have migrated your server to the new Network stack and have at least one flexible IP attached to the Instance.

List all flexible IPs

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/ips

List all flexible IPs in a specified zone.

List all flexible IPs › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List all flexible IPs › query Parameters

project

string

Project ID in which the IPs are reserved.

organization

string

Organization ID in which the IPs are reserved.

tags

string

Filter IPs with these exact tags (to filter with several tags, use commas to separate them).

name

string

Filter on the IP address (Works as a LIKE operation on the IP address).

per_page

integer · uint32

A positive integer lower or equal to 100 to select the number of items to return.

page

integer · int32

A positive integer to choose the page to return.

type

string

Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').

List all flexible IPs › Responses

200

scaleway.instance.v1.ListIpsResponse

scaleway.instance.v1.Ip[]

List of ips.

Reserve a flexible IP

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/ips

Reserve a flexible IP and attach it to the specified Instance.

Reserve a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Reserve a flexible IP › Request Body

project

string

Project ID in which the IP is reserved.

tags

string[]

Tags of the IP.

server

string

UUID of the Instance you want to attach the IP to.

type

string · enum

IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').

Enum values:

unknown_iptype

routed_ipv4

routed_ipv6

Default: unknown_iptype

Reserve a flexible IP › Responses

scaleway.instance.v1.CreateIpResponse

scaleway.instance.v1.Ip

POST/instance/v1/zones/{zone}/ips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/instance/v1/zones/{zone}/ips"

Example Request Body

{
  "organization": "organization",
  "project": "project",
  "tags": [
    "string"
  ],
  "server": "server",
  "type": "unknown_iptype"
}

json

Example Responses

{
  "ip": {
    "id": "id",
    "address": "1.2.3.4",
    "reverse": "reverse",
    "server": {
      "id": "id",
      "name": "name"
    },
    "organization": "organization",
    "tags": [
      "string"
    ],
    "project": "project",
    "type": "unknown_iptype",
    "state": "unknown_state",
    "prefix": "1.2.3.4/32",
    "ipam_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "zone"
  }
}

json

application/json

Releases the reserved IP without deleting the reservation.

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip_id}/release-to-ipam

The IP remains available in IPAM, which means that it is still reserved by the Organization, and can be reattached to another resource (Instance or other product).

Releases the reserved IP without deleting the reservation. › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip_id

string · required

ID of the IP you want to release from the Instance but retain in IPAM.

Releases the reserved IP without deleting the reservation. › Request Body

Releases the reserved IP without deleting the reservation. › Responses

No data returned

Get a flexible IP

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip}

Get details of an IP with the specified ID or address.

Get a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip

string · required

IP ID or address to get.

Get a flexible IP › Responses

200

scaleway.instance.v1.GetIpResponse

scaleway.instance.v1.Ip

Delete a flexible IP

DELETE

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip}

Delete the IP with the specified ID.

Delete a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip

string · required

ID or address of the IP to delete.

Delete a flexible IP › Responses

No data returned

Update a flexible IP

PATCH

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip}

Update a flexible IP in the specified zone with the specified ID.

Update a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip

string · required

IP ID or IP address.

Update a flexible IP › Request Body

reverse

string

Reverse domain name.

type

string · enum

Should have no effect.

Enum values:

unknown_iptype

routed_ipv4

routed_ipv6

Default: unknown_iptype

tags

string[]

An array of keywords you want to tag this IP with.

server

scaleway.instance.v1.NullableStringValue

Update a flexible IP › Responses

200

scaleway.instance.v1.UpdateIpResponse

scaleway.instance.v1.Ip

Volume Types Volumes

List all flexible IPs

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/ips

List all flexible IPs in a specified zone.

List all flexible IPs › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List all flexible IPs › query Parameters

project

string

Project ID in which the IPs are reserved.

organization

string

Organization ID in which the IPs are reserved.

tags

string

Filter IPs with these exact tags (to filter with several tags, use commas to separate them).

name

string

Filter on the IP address (Works as a LIKE operation on the IP address).

per_page

integer · uint32

A positive integer lower or equal to 100 to select the number of items to return.

page

integer · int32

A positive integer to choose the page to return.

type

string

Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').

List all flexible IPs › Responses

200

scaleway.instance.v1.ListIpsResponse

scaleway.instance.v1.Ip[]

List of ips.

Reserve a flexible IP

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/ips

Reserve a flexible IP and attach it to the specified Instance.

Reserve a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Reserve a flexible IP › Request Body

project

string

Project ID in which the IP is reserved.

tags

string[]

Tags of the IP.

server

string

UUID of the Instance you want to attach the IP to.

type

string · enum

IP type to reserve (either 'routed_ipv4' or 'routed_ipv6').

Enum values:

unknown_iptype

routed_ipv4

routed_ipv6

Default: unknown_iptype

Reserve a flexible IP › Responses

scaleway.instance.v1.CreateIpResponse

scaleway.instance.v1.Ip

Releases the reserved IP without deleting the reservation.

POST

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip_id}/release-to-ipam

The IP remains available in IPAM, which means that it is still reserved by the Organization, and can be reattached to another resource (Instance or other product).

Releases the reserved IP without deleting the reservation. › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip_id

string · required

ID of the IP you want to release from the Instance but retain in IPAM.

Releases the reserved IP without deleting the reservation. › Request Body

Releases the reserved IP without deleting the reservation. › Responses

No data returned

Get a flexible IP

GET

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip}

Get details of an IP with the specified ID or address.

Get a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip

string · required

IP ID or address to get.

Get a flexible IP › Responses

200

scaleway.instance.v1.GetIpResponse

scaleway.instance.v1.Ip

Delete a flexible IP

DELETE

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip}

Delete the IP with the specified ID.

Delete a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip

string · required

ID or address of the IP to delete.

Delete a flexible IP › Responses

No data returned

Update a flexible IP

PATCH

https://api.scaleway.com

/instance/v1/zones/{zone}/ips/{ip}

Update a flexible IP in the specified zone with the specified ID.

Update a flexible IP › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

ip

string · required

IP ID or IP address.

Update a flexible IP › Request Body

reverse

string

Reverse domain name.

type

string · enum

Should have no effect.

Enum values:

unknown_iptype

routed_ipv4

routed_ipv6

Default: unknown_iptype

tags

string[]

An array of keywords you want to tag this IP with.

server

scaleway.instance.v1.NullableStringValue

Update a flexible IP › Responses

200

scaleway.instance.v1.UpdateIpResponse

scaleway.instance.v1.Ip