IPs

An IP address is the building block for network communications in a VPC or on the public Internet.

List existing IPs

GET

https://api.scaleway.com

/ipam/v1/regions/{region}/ips

List existing IPs in the specified region using various filters. For example, you can filter for IPs within a specified Private Network, or for public IPs within a specified Project. By default, the IPs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List existing IPs › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List existing IPs › query Parameters

order_by

string · enum

Sort order of the returned IPs.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

attached_at_desc

attached_at_asc

ip_address_desc

ip_address_asc

Default: created_at_desc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of IPs to return per page.

project_id

string

Project ID to filter for. Only IPs belonging to this Project will be returned. (UUID format)

vpc_id

string

VPC ID to filter for. Only IPs owned by resources in this VPC will be returned.

attached

boolean

Defines whether to filter only for IPs which are attached to a resource.

resource_name

string

Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.

resource_id

string

Resource ID to filter for. Only IPs attached to this resource will be returned. (UUID format)

resource_ids

string[]

Resource IDs to filter for. Only IPs attached to at least one of these resources will be returned.

resource_type

string · enum

Resource type to filter for. Only IPs attached to this type of resource will be returned.

Enum values:

unknown_type

custom

instance_server

instance_ip

instance_private_nic

lb_server

fip_ip

vpc_gateway

Default: unknown_type

resource_types

scaleway.ipam.v1.Resource.Type[]

Resource types to filter for. Only IPs attached to these types of resources will be returned.

Enum values:

unknown_type

custom

instance_server

instance_ip

instance_private_nic

lb_server

fip_ip

vpc_gateway

mac_address

string

MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned.

tags

string[]

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

organization_id

string

Organization ID to filter for. Only IPs belonging to this Organization will be returned. (UUID format)

is_ipv6

boolean

Defines whether to filter only for IPv4s or IPv6s.

ip_ids

string[]

IP IDs to filter for. Only IPs with these UUIDs will be returned.

List existing IPs › Responses

200

scaleway.ipam.v1.ListIPsResponse

total_count

integer · uint64

scaleway.ipam.v1.IP[]

GET/ipam/v1/regions/{region}/ips

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips"

Example Responses

{
  "total_count": 0,
  "ips": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "address": "1.2.3.4/32",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "is_ipv6": true,
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "source": {
        "zonal": "zonal",
        "private_network_id": "private_network_id",
        "subnet_id": "subnet_id",
        "vpc_id": "vpc_id"
      },
      "resource": {
        "type": "unknown_type",
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "mac_address": "mac_address",
        "name": "name"
      },
      "tags": [
        "string"
      ],
      "reverses": [
        {
          "hostname": "hostname",
          "address": "1.2.3.4"
        }
      ],
      "region": "region",
      "zone": "zone"
    }
  ]
}

json

application/json

Reserve a new IP

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips

Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network.

Reserve a new IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Reserve a new IP › Request Body

project_id

string · required

Scaleway Project in which to create the IP. When creating an IP in a Private Network, the Project must match the Private Network's Project. (UUID format)

object · required

Source in which to reserve the IP. Not all sources are available for reservation.

is_ipv6

boolean

Request an IPv6 instead of an IPv4.

address

string

Request this specific IP address in the specified source pool. The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already reserved, then the call will fail. (IP address)

tags

string[]

Tags for the IP.

object

Custom resource to attach to the IP being reserved. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this for attaching IP addresses to standard Scaleway resources, as it will fail - instead, see the relevant product API for an equivalent method.

Reserve a new IP › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "is_ipv6": false,
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "source": {
        "private_network_id": "string",
        "subnet_id": "string",
        "vpc_id": "string",
        "zonal": "string"
    }
  }' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "is_ipv6": true,
  "address": "1.2.3.4",
  "tags": [
    "string"
  ],
  "resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Get an IP

GET

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}

Retrieve details of an existing IP, specified by its IP ID.

Get an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Get an IP › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

GET/ipam/v1/regions/{region}/ips/{ip_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Release an IP

DELETE

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}

Release an IP not currently attached to a resource, and returns it to the available IP pool.

Release an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Release an IP › Request Body

Release an IP › Responses

No data returned

Update an IP

PATCH

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}

Update parameters including tags of the specified IP.

Update an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Update an IP › Request Body

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverse domain names associated with an IP in the subnet of the current IP.

Update an IP › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

PATCH/ipam/v1/regions/{region}/ips/{ip_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}"

Example Request Body

{
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Attach private IP to custom resource

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}/attach

Attach an existing reserved private IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.

Attach private IP to custom resource › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Attach private IP to custom resource › Request Body

object · required

Custom resource to be attached to the IP.

Attach private IP to custom resource › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips/{ip_id}/attach

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource":{"mac_address":"string","name":"string"}}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}/attach"

Example Request Body

{
  "resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Detach private IP from a custom resource

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}/detach

Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.

Detach private IP from a custom resource › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Detach private IP from a custom resource › Request Body

object · required

Custom resource currently attached to the IP.

Detach private IP from a custom resource › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips/{ip_id}/detach

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource":{"mac_address":"string","name":"string"}}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}/detach"

Example Request Body

{
  "resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Move private IP to a custom resource

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}/move

Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.

Move private IP to a custom resource › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Move private IP to a custom resource › Request Body

object · required

Custom resource currently attached to the IP.

object

Custom resource to be attached to the IP.

Move private IP to a custom resource › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips/{ip_id}/move

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from_resource":{"mac_address":"string","name":"string"}}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}/move"

Example Request Body

{
  "from_resource": {
    "mac_address": "mac_address",
    "name": "name"
  },
  "to_resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Other endpoints

IPAM API

IPs

Download schema

An IP address is the building block for network communications in a VPC or on the public Internet.

List existing IPs

GET

https://api.scaleway.com

/ipam/v1/regions/{region}/ips

List existing IPs › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List existing IPs › query Parameters

order_by

string · enum

Sort order of the returned IPs.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

attached_at_desc

attached_at_asc

ip_address_desc

ip_address_asc

Default: created_at_desc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of IPs to return per page.

project_id

string

Project ID to filter for. Only IPs belonging to this Project will be returned. (UUID format)

vpc_id

string

VPC ID to filter for. Only IPs owned by resources in this VPC will be returned.

attached

boolean

Defines whether to filter only for IPs which are attached to a resource.

resource_name

string

Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.

resource_id

string

Resource ID to filter for. Only IPs attached to this resource will be returned. (UUID format)

resource_ids

string[]

Resource IDs to filter for. Only IPs attached to at least one of these resources will be returned.

resource_type

string · enum

Resource type to filter for. Only IPs attached to this type of resource will be returned.

Enum values:

unknown_type

custom

instance_server

instance_ip

instance_private_nic

lb_server

fip_ip

vpc_gateway

Default: unknown_type

resource_types

scaleway.ipam.v1.Resource.Type[]

Resource types to filter for. Only IPs attached to these types of resources will be returned.

Enum values:

unknown_type

custom

instance_server

instance_ip

instance_private_nic

lb_server

fip_ip

vpc_gateway

mac_address

string

MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned.

tags

string[]

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

organization_id

string

Organization ID to filter for. Only IPs belonging to this Organization will be returned. (UUID format)

is_ipv6

boolean

Defines whether to filter only for IPv4s or IPv6s.

ip_ids

string[]

IP IDs to filter for. Only IPs with these UUIDs will be returned.

List existing IPs › Responses

200

scaleway.ipam.v1.ListIPsResponse

total_count

integer · uint64

scaleway.ipam.v1.IP[]

GET/ipam/v1/regions/{region}/ips

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips"

Example Responses

{
  "total_count": 0,
  "ips": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "address": "1.2.3.4/32",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "is_ipv6": true,
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "source": {
        "zonal": "zonal",
        "private_network_id": "private_network_id",
        "subnet_id": "subnet_id",
        "vpc_id": "vpc_id"
      },
      "resource": {
        "type": "unknown_type",
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "mac_address": "mac_address",
        "name": "name"
      },
      "tags": [
        "string"
      ],
      "reverses": [
        {
          "hostname": "hostname",
          "address": "1.2.3.4"
        }
      ],
      "region": "region",
      "zone": "zone"
    }
  ]
}

json

application/json

Reserve a new IP

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips

Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network.

Reserve a new IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Reserve a new IP › Request Body

project_id

string · required

Scaleway Project in which to create the IP. When creating an IP in a Private Network, the Project must match the Private Network's Project. (UUID format)

object · required

Source in which to reserve the IP. Not all sources are available for reservation.

is_ipv6

boolean

Request an IPv6 instead of an IPv4.

address

string

tags

string[]

Tags for the IP.

object

Reserve a new IP › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "is_ipv6": false,
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "source": {
        "private_network_id": "string",
        "subnet_id": "string",
        "vpc_id": "string",
        "zonal": "string"
    }
  }' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "is_ipv6": true,
  "address": "1.2.3.4",
  "tags": [
    "string"
  ],
  "resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Get an IP

GET

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}

Retrieve details of an existing IP, specified by its IP ID.

Get an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Get an IP › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

GET/ipam/v1/regions/{region}/ips/{ip_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Release an IP

DELETE

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}

Release an IP not currently attached to a resource, and returns it to the available IP pool.

Release an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Release an IP › Request Body

Release an IP › Responses

No data returned

Update an IP

PATCH

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}

Update parameters including tags of the specified IP.

Update an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Update an IP › Request Body

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverse domain names associated with an IP in the subnet of the current IP.

Update an IP › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

PATCH/ipam/v1/regions/{region}/ips/{ip_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}"

Example Request Body

{
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Attach private IP to custom resource

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}/attach

Attach private IP to custom resource › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Attach private IP to custom resource › Request Body

object · required

Custom resource to be attached to the IP.

Attach private IP to custom resource › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips/{ip_id}/attach

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource":{"mac_address":"string","name":"string"}}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}/attach"

Example Request Body

{
  "resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Detach private IP from a custom resource

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}/detach

Detach private IP from a custom resource › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Detach private IP from a custom resource › Request Body

object · required

Custom resource currently attached to the IP.

Detach private IP from a custom resource › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips/{ip_id}/detach

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource":{"mac_address":"string","name":"string"}}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}/detach"

Example Request Body

{
  "resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Move private IP to a custom resource

POST

https://api.scaleway.com

/ipam/v1/regions/{region}/ips/{ip_id}/move

Move private IP to a custom resource › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

ip_id

string · required

IP ID. (UUID format)

Move private IP to a custom resource › Request Body

object · required

Custom resource currently attached to the IP.

object

Custom resource to be attached to the IP.

Move private IP to a custom resource › Responses

200

scaleway.ipam.v1.IP

id

string

IP ID. (UUID format)

address

string

IPv4 or IPv6 address in CIDR notation. (IP network)

project_id

string

Scaleway Project the IP belongs to. (UUID format)

is_ipv6

boolean

Defines whether the IP is an IPv6 (false = IPv4).

created_at

string · date-time

Date the IP was reserved. (RFC 3339 format)

updated_at

string · date-time

Date the IP was last modified. (RFC 3339 format)

object

Source pool where the IP was reserved in.

object

Resource which the IP is attached to.

tags

string[]

Tags for the IP.

scaleway.ipam.v1.Reverse[]

Array of reverses associated with the IP.

region

string

Region of the IP.

zone

string

Zone of the IP, if zonal.

POST/ipam/v1/regions/{region}/ips/{ip_id}/move

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from_resource":{"mac_address":"string","name":"string"}}' \
  "https://api.scaleway.com/ipam/v1/regions/{region}/ips/{ip_id}/move"

Example Request Body

{
  "from_resource": {
    "mac_address": "mac_address",
    "name": "name"
  },
  "to_resource": {
    "mac_address": "mac_address",
    "name": "name"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "is_ipv6": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "source": {
    "zonal": "zonal",
    "private_network_id": "private_network_id",
    "subnet_id": "subnet_id",
    "vpc_id": "vpc_id"
  },
  "resource": {
    "type": "unknown_type",
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "mac_address": "mac_address",
    "name": "name"
  },
  "tags": [
    "string"
  ],
  "reverses": [
    {
      "hostname": "hostname",
      "address": "1.2.3.4"
    }
  ],
  "region": "region",
  "zone": "zone"
}

json

application/json

Other endpoints