Flexible IP

Download schema

A flexible IP can be attached to any Elastic Metal server within the same zone. Multiple flexible IPs can be attached to a server.

List flexible IPs

GET

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips

List all flexible IPs within a given zone.

List flexible IPs › 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

pl-waw-2

pl-waw-3

List flexible IPs › query Parameters

order_by

scaleway.flexible_ip.v1alpha1.ListFlexibleIPsRequest.OrderBy · enum

Sort order of the returned flexible IPs.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

page

integer · int32

Page number.

page_size

integer · uint32

Maximum number of flexible IPs per page.

tags

string[]

Filter by tag, only flexible IPs with one or more matching tags will be returned.

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status[]

Filter by status, only flexible IPs with this status will be returned.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

server_ids

string[]

Filter by server IDs, only flexible IPs with these server IDs will be returned.

organization_id

string

Filter by Organization ID, only flexible IPs from this Organization will be returned.

project_id

string

Filter by Project ID, only flexible IPs from this Project will be returned.

List flexible IPs › Responses

200

scaleway.flexible_ip.v1alpha1.ListFlexibleIPsResponse

total_count

integer · uint32

Total count of matching flexible IPs.

scaleway.flexible_ip.v1alpha1.FlexibleIP[]

List of all flexible IPs.

GET/flexible-ip/v1alpha1/zones/{zone}/fips

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips"

Example Responses

{
  "total_count": 0,
  "flexible_ips": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "description": "description",
      "tags": [
        "string"
      ],
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown",
      "ip_address": "1.2.3.4/32",
      "mac_address": {
        "id": "id",
        "mac_address": "mac_address",
        "mac_type": "unknown_type",
        "status": "unknown",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "zone": "zone"
      },
      "server_id": "server_id",
      "reverse": "reverse",
      "zone": "zone",
      "srn": "srn"
    }
  ]
}

json

application/json

Create a new flexible IP

POST

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips

Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.

Create a new flexible IP › 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

pl-waw-2

pl-waw-3

Create a new flexible IP › Request Body

project_id

string · required

ID of the project to associate with the Flexible IP.

description

string

Flexible IP description (max. of 255 characters).

tags

string[]

Tags to associate to the flexible IP.

server_id

string | null

ID of the server to which the newly created flexible IP will be attached.

reverse

string | null

Value of the reverse DNS.

is_ipv6

boolean

Defines whether the flexible IP has an IPv6 address.

Create a new flexible IP › Responses

200

scaleway.flexible_ip.v1alpha1.FlexibleIP

id

string

ID of the flexible IP.

organization_id

string

ID of the Organization the flexible IP is attached to.

project_id

string

ID of the Project the flexible IP is attached to.

description

string

Flexible IP description.

tags

string[]

Flexible IP tags.

updated_at

string | null · date-time

Date on which the flexible IP was last updated. (RFC 3339 format)

created_at

string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status · enum

Flexible IP status.

ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
attached: flexible IP is attached to a server
error: a flexible IP operation resulted in an error
detaching: flexible IP is being detached from a server
locked: the resource of the flexible IP is locked.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

Default: unknown

ip_address

string

IP of the flexible IP. (IP network)

scaleway.flexible_ip.v1alpha1.MACAddress

MAC address of the flexible IP.

server_id

string | null

ID of the server linked to the flexible IP.

reverse

string

Reverse DNS value.

zone

string

Availability Zone of the flexible IP.

srn

string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

POST/flexible-ip/v1alpha1/zones/{zone}/fips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "is_ipv6": false,
    "project_id": "string"
  }' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips"

Example Request Body

{
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "server_id": "server_id",
  "reverse": "reverse",
  "is_ipv6": true
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "ip_address": "1.2.3.4/32",
  "mac_address": {
    "id": "id",
    "mac_address": "mac_address",
    "mac_type": "unknown_type",
    "status": "unknown",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "zone": "zone"
  },
  "server_id": "server_id",
  "reverse": "reverse",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Get an existing flexible IP

GET

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}

Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.

Get an existing flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

ID of the flexible IP.

Get an existing flexible IP › Responses

200

scaleway.flexible_ip.v1alpha1.FlexibleIP

id

string

ID of the flexible IP.

organization_id

string

ID of the Organization the flexible IP is attached to.

project_id

string

ID of the Project the flexible IP is attached to.

description

string

Flexible IP description.

tags

string[]

Flexible IP tags.

updated_at

string | null · date-time

Date on which the flexible IP was last updated. (RFC 3339 format)

created_at

string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status · enum

Flexible IP status.

ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
attached: flexible IP is attached to a server
error: a flexible IP operation resulted in an error
detaching: flexible IP is being detached from a server
locked: the resource of the flexible IP is locked.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

Default: unknown

ip_address

string

IP of the flexible IP. (IP network)

scaleway.flexible_ip.v1alpha1.MACAddress

MAC address of the flexible IP.

server_id

string | null

ID of the server linked to the flexible IP.

reverse

string

Reverse DNS value.

zone

string

Availability Zone of the flexible IP.

srn

string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

GET/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "ip_address": "1.2.3.4/32",
  "mac_address": {
    "id": "id",
    "mac_address": "mac_address",
    "mac_type": "unknown_type",
    "status": "unknown",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "zone": "zone"
  },
  "server_id": "server_id",
  "reverse": "reverse",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Update an existing flexible IP

PATCH

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}

Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.

Update an existing flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

ID of the flexible IP to update.

Update an existing flexible IP › Request Body

description

string | null

Flexible IP description (max. 255 characters).

tags

array | null

Tags associated with the flexible IP.

reverse

string | null

Value of the reverse DNS.

Update an existing flexible IP › Responses

200

scaleway.flexible_ip.v1alpha1.FlexibleIP

id

string

ID of the flexible IP.

organization_id

string

ID of the Organization the flexible IP is attached to.

project_id

string

ID of the Project the flexible IP is attached to.

description

string

Flexible IP description.

tags

string[]

Flexible IP tags.

updated_at

string | null · date-time

Date on which the flexible IP was last updated. (RFC 3339 format)

created_at

string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status · enum

Flexible IP status.

ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
attached: flexible IP is attached to a server
error: a flexible IP operation resulted in an error
detaching: flexible IP is being detached from a server
locked: the resource of the flexible IP is locked.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

Default: unknown

ip_address

string

IP of the flexible IP. (IP network)

scaleway.flexible_ip.v1alpha1.MACAddress

MAC address of the flexible IP.

server_id

string | null

ID of the server linked to the flexible IP.

reverse

string

Reverse DNS value.

zone

string

Availability Zone of the flexible IP.

srn

string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

PATCH/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}"

Example Request Body

{
  "description": "description",
  "tags": [],
  "reverse": "reverse"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "ip_address": "1.2.3.4/32",
  "mac_address": {
    "id": "id",
    "mac_address": "mac_address",
    "mac_type": "unknown_type",
    "status": "unknown",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "zone": "zone"
  },
  "server_id": "server_id",
  "reverse": "reverse",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Delete an existing flexible IP

DELETE

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}

Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.

Delete an existing flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

ID of the flexible IP to delete.

Delete an existing flexible IP › Responses

No data returned

Generate a virtual MAC address on an existing flexible IP

POST

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac

Generate a virtual MAC (Media Access Control) address on an existing flexible IP.

Generate a virtual MAC address on an existing flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

ID of the flexible IP for which to generate a virtual MAC.

Generate a virtual MAC address on an existing flexible IP › Request Body

mac_type

scaleway.flexible_ip.v1alpha1.MACAddress.Type · enum · required

TODO.

Enum values:

unknown_type

vmware

xen

kvm

Default: unknown_type

Generate a virtual MAC address on an existing flexible IP › Responses

200

scaleway.flexible_ip.v1alpha1.FlexibleIP

id

string

ID of the flexible IP.

organization_id

string

ID of the Organization the flexible IP is attached to.

project_id

string

ID of the Project the flexible IP is attached to.

description

string

Flexible IP description.

tags

string[]

Flexible IP tags.

updated_at

string | null · date-time

Date on which the flexible IP was last updated. (RFC 3339 format)

created_at

string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status · enum

Flexible IP status.

ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
attached: flexible IP is attached to a server
error: a flexible IP operation resulted in an error
detaching: flexible IP is being detached from a server
locked: the resource of the flexible IP is locked.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

Default: unknown

ip_address

string

IP of the flexible IP. (IP network)

scaleway.flexible_ip.v1alpha1.MACAddress

MAC address of the flexible IP.

server_id

string | null

ID of the server linked to the flexible IP.

reverse

string

Reverse DNS value.

zone

string

Availability Zone of the flexible IP.

srn

string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

POST/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mac_type":"unknown_type"}' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac"

Example Request Body

{
  "mac_type": "unknown_type"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "ip_address": "1.2.3.4/32",
  "mac_address": {
    "id": "id",
    "mac_address": "mac_address",
    "mac_type": "unknown_type",
    "status": "unknown",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "zone": "zone"
  },
  "server_id": "server_id",
  "reverse": "reverse",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Detach a given virtual MAC address from an existing flexible IP

DELETE

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac

Detach a given MAC (Media Access Control) address from an existing flexible IP.

Detach a given virtual MAC address from an existing flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

ID of the flexible IP from which to delete the virtual MAC. If the flexible IP belongs to a MAC group, the MAC will be removed from both the MAC group and flexible IP.

Detach a given virtual MAC address from an existing flexible IP › Responses

No data returned

Duplicate a virtual MAC address to another flexible IP

POST

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/duplicate

Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.

Duplicate a virtual MAC address to another flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

ID of the flexible IP on which to duplicate the virtual MAC. Note that the flexible IPs need to be attached to the same server.

Duplicate a virtual MAC address to another flexible IP › Request Body

duplicate_from_fip_id

string · required

ID of the flexible IP to duplicate the Virtual MAC from. Note that flexible IPs need to be attached to the same server.

Duplicate a virtual MAC address to another flexible IP › Responses

200

scaleway.flexible_ip.v1alpha1.FlexibleIP

id

string

ID of the flexible IP.

organization_id

string

ID of the Organization the flexible IP is attached to.

project_id

string

ID of the Project the flexible IP is attached to.

description

string

Flexible IP description.

tags

string[]

Flexible IP tags.

updated_at

string | null · date-time

Date on which the flexible IP was last updated. (RFC 3339 format)

created_at

string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status · enum

Flexible IP status.

ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
attached: flexible IP is attached to a server
error: a flexible IP operation resulted in an error
detaching: flexible IP is being detached from a server
locked: the resource of the flexible IP is locked.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

Default: unknown

ip_address

string

IP of the flexible IP. (IP network)

scaleway.flexible_ip.v1alpha1.MACAddress

MAC address of the flexible IP.

server_id

string | null

ID of the server linked to the flexible IP.

reverse

string

Reverse DNS value.

zone

string

Availability Zone of the flexible IP.

srn

string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

POST/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/duplicate

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"duplicate_from_fip_id":"string"}' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/duplicate"

Example Request Body

{
  "duplicate_from_fip_id": "duplicate_from_fip_id"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "ip_address": "1.2.3.4/32",
  "mac_address": {
    "id": "id",
    "mac_address": "mac_address",
    "mac_type": "unknown_type",
    "status": "unknown",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "zone": "zone"
  },
  "server_id": "server_id",
  "reverse": "reverse",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Relocate an existing virtual MAC address to a different flexible IP

POST

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/move

Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.

Relocate an existing virtual MAC address to a different flexible IP › 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

pl-waw-2

pl-waw-3

fip_id

string · required

Relocate an existing virtual MAC address to a different flexible IP › Request Body

dst_fip_id

string

Relocate an existing virtual MAC address to a different flexible IP › Responses

200

scaleway.flexible_ip.v1alpha1.FlexibleIP

id

string

ID of the flexible IP.

organization_id

string

ID of the Organization the flexible IP is attached to.

project_id

string

ID of the Project the flexible IP is attached to.

description

string

Flexible IP description.

tags

string[]

Flexible IP tags.

updated_at

string | null · date-time

Date on which the flexible IP was last updated. (RFC 3339 format)

created_at

string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

status

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status · enum

Flexible IP status.

ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
attached: flexible IP is attached to a server
error: a flexible IP operation resulted in an error
detaching: flexible IP is being detached from a server
locked: the resource of the flexible IP is locked.

Enum values:

unknown

ready

updating

attached

error

detaching

locked

Default: unknown

ip_address

string

IP of the flexible IP. (IP network)

scaleway.flexible_ip.v1alpha1.MACAddress

MAC address of the flexible IP.

server_id

string | null

ID of the server linked to the flexible IP.

reverse

string

Reverse DNS value.

zone

string

Availability Zone of the flexible IP.

srn

string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

POST/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/move

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dst_fip_id":"string"}' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/move"

Example Request Body

{
  "dst_fip_id": "dst_fip_id"
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "description": "description",
  "tags": [
    "string"
  ],
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown",
  "ip_address": "1.2.3.4/32",
  "mac_address": {
    "id": "id",
    "mac_address": "mac_address",
    "mac_type": "unknown_type",
    "status": "unknown",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "zone": "zone"
  },
  "server_id": "server_id",
  "reverse": "reverse",
  "zone": "zone",
  "srn": "srn"
}

json

application/json

Attach an existing flexible IP to a server

POST

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/attach

Attach an existing flexible IP to a specified Elastic Metal server.

Attach an existing flexible IP to a server › 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

pl-waw-2

pl-waw-3

Attach an existing flexible IP to a server › Request Body

fips_ids

string[] · required

List of flexible IP IDs to attach to a server. Multiple IDs can be provided, but note that flexible IPs must belong to the same MAC group (see details about MAC groups).

server_id

string · required

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

Attach an existing flexible IP to a server › Responses

200

scaleway.flexible_ip.v1alpha1.AttachFlexibleIPsResponse

total_count

integer · uint32

Total count of flexible IPs that are being updated.

scaleway.flexible_ip.v1alpha1.FlexibleIP[]

List of flexible IPs in an updating state.

POST/flexible-ip/v1alpha1/zones/{zone}/fips/attach

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fips_ids":["string"],"server_id":"string"}' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/attach"

Example Request Body

{
  "fips_ids": [
    "string"
  ],
  "server_id": "server_id"
}

json

Example Responses

{
  "total_count": 0,
  "flexible_ips": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "description": "description",
      "tags": [
        "string"
      ],
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown",
      "ip_address": "1.2.3.4/32",
      "mac_address": {
        "id": "id",
        "mac_address": "mac_address",
        "mac_type": "unknown_type",
        "status": "unknown",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "zone": "zone"
      },
      "server_id": "server_id",
      "reverse": "reverse",
      "zone": "zone",
      "srn": "srn"
    }
  ]
}

json

application/json

Detach an existing flexible IP from a server

POST

https://api.scaleway.com

/flexible-ip/v1alpha1/zones/{zone}/fips/detach

Detach an existing flexible IP from a specified Elastic Metal server.

Detach an existing flexible IP from a server › 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

pl-waw-2

pl-waw-3

Detach an existing flexible IP from a server › Request Body

fips_ids

string[] · required

List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.

Detach an existing flexible IP from a server › Responses

200

scaleway.flexible_ip.v1alpha1.DetachFlexibleIPsResponse

total_count

integer · uint32

Total count of flexible IPs that are being detached.

scaleway.flexible_ip.v1alpha1.FlexibleIP[]

List of flexible IPs in a detaching state.

POST/flexible-ip/v1alpha1/zones/{zone}/fips/detach

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fips_ids":["string"]}' \
  "https://api.scaleway.com/flexible-ip/v1alpha1/zones/{zone}/fips/detach"

Example Request Body

{
  "fips_ids": [
    "string"
  ]
}

json

Example Responses

{
  "total_count": 0,
  "flexible_ips": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "description": "description",
      "tags": [
        "string"
      ],
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown",
      "ip_address": "1.2.3.4/32",
      "mac_address": {
        "id": "id",
        "mac_address": "mac_address",
        "mac_type": "unknown_type",
        "status": "unknown",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "zone": "zone"
      },
      "server_id": "server_id",
      "reverse": "reverse",
      "zone": "zone",
      "srn": "srn"
    }
  ]
}

json

application/json