Failover IPs

Download schema

List failovers for project

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips

List failovers servers for project.

List failovers for project › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

List failovers for project › query Parameters

page

integer · uint32

Page number.

page_size

integer · uint32

Number of failovers IP per page.

order_by

scaleway.dedibox.v1.ListFailoverIPsRequest.OrderBy · enum

Order of the failovers IP.

Enum values:

ip_asc

ip_desc

Default: ip_asc

project_id

string

Filter failovers IP by project ID.

search

string

Filter failovers IP which matching with this field.

only_available

boolean

True: return all failovers IP not attached on server. True: return all failovers IP not attached on server false: return all failovers IP attached on server.

List failovers for project › Responses

200

scaleway.dedibox.v1.ListFailoverIPsResponse

total_count

integer · uint32

Total count of matching failovers IP.

scaleway.dedibox.v1.FailoverIP[]

List of failover IPs that match filters.

GET/dedibox/v1/zones/{zone}/failover-ips

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/failover-ips?project_id=string"

Example Responses

{
  "total_count": 0,
  "failover_ips": [
    {
      "id": 0,
      "address": "1.2.3.4",
      "reverse": "reverse",
      "ip_version": "unknown_version",
      "cidr": 0,
      "netmask": "1.2.3.4",
      "gateway_ip": "1.2.3.4",
      "mac": "mac",
      "server_id": 0,
      "status": "unknown_status",
      "block": {
        "id": 0,
        "address": "1.2.3.4",
        "nameservers": [
          "string"
        ],
        "ip_version": "unknown_version",
        "cidr": 0,
        "netmask": "1.2.3.4",
        "gateway_ip": "1.2.3.4"
      },
      "type": "unknown",
      "server_zone": "server_zone"
    }
  ]
}

json

application/json

Order failover IPs

POST

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips

Order X failover IPs.

Order failover IPs › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

Order failover IPs › Request Body

offer_id

integer · uint64

Failover IP offer ID.

project_id

string

Project ID.

quantity

integer · uint32

Quantity.

Order failover IPs › Responses

200

scaleway.dedibox.v1.CreateFailoverIPsResponse

total_count

integer · uint32

scaleway.dedibox.v1.Service[]

POST/dedibox/v1/zones/{zone}/failover-ips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "offer_id": 42,
    "project_id": "string",
    "quantity": 42
  }' \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/failover-ips"

Example Request Body

{
  "offer_id": 0,
  "project_id": "project_id",
  "quantity": 0
}

json

Example Responses

{
  "total_count": 0,
  "services": [
    {
      "id": 0,
      "resource_id": 0,
      "provisioning_status": "unknown",
      "offer": {
        "id": 0,
        "name": "name",
        "catalog": "all",
        "payment_frequency": "monthly",
        "pricing": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        },
        "offer_id": 0,
        "server_info": {
          "bandwidth": 0,
          "stock": "empty",
          "commercial_range": "commercial_range",
          "disks": [
            {
              "capacity": 0,
              "type": "sata"
            }
          ],
          "cpus": [
            {
              "name": "name",
              "core_count": 0,
              "thread_count": 0,
              "frequency": 0
            }
          ],
          "memories": [
            {
              "capacity": 0,
              "type": "ddr2",
              "frequency": 0,
              "is_ecc": true
            }
          ],
          "persistent_memories": [
            {
              "capacity": 0,
              "frequency": 0,
              "model": "model"
            }
          ],
          "raid_controllers": [
            {
              "model": "model",
              "raid_level": [
                "string"
              ]
            }
          ],
          "available_options": [
            null
          ],
          "rpn_version": 0,
          "connectivity": 0,
          "stock_by_datacenter": {
            "<stock_by_datacenterKey>": "empty"
          }
        },
        "service_level_info": {
          "support_ticket": true,
          "support_phone": true,
          "sales_support": true,
          "git": "git",
          "sla": 0,
          "priority_support": true,
          "high_rpn_bandwidth": true,
          "customization": true,
          "antidos": true,
          "extra_failover_quota": 0,
          "available_options": [
            null
          ]
        },
        "rpn_info": {
          "speed": 0
        },
        "san_info": {
          "size": 0,
          "ha": true,
          "device_type": "hdd"
        },
        "antidos_info": {
          "type": "minimal"
        },
        "backup_info": {
          "size": 0
        },
        "usb_storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "storage_info": {
          "max_quota": 0,
          "size": 0
        },
        "license_info": {
          "bound_to_ip": true
        },
        "failover_ip_info": {},
        "failover_block_info": {},
        "bandwidth_info": {
          "speed": 0
        }
      },
      "created_at": "2022-03-22T12:34:56.123456Z",
      "delivered_at": "2022-03-22T12:34:56.123456Z",
      "terminated_at": "2022-03-22T12:34:56.123456Z",
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "type": "unknown_type"
    }
  ]
}

json

application/json

Get a specific baremetal server

GET

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips/{ip_id}

Get the server associated with the given ID.

Get a specific baremetal server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

ip_id

integer · uint64 · required

ID of the failover IP.

Get a specific baremetal server › Responses

200

scaleway.dedibox.v1.FailoverIP

id

integer · uint64

ID of the failover IP.

address

string

IP of the failover IP. (IP address)

reverse

string

Reverse IP value.

ip_version

scaleway.dedibox.v1.FailoverIP.Version · enum

IP version of the failover IP.

Enum values:

unknown_version

ipv4

ipv6

Default: unknown_version

cidr

integer · uint32

Classless InterDomain Routing notation of the failover IP.

netmask

string

Netmask of the failover IP. (IP address)

gateway_ip

string

Gateway IP of the failover IP. (IP address)

mac

string | null

MAC address of the IP failover.

server_id

integer | null · uint64

Server ID linked to the IP failover.

status

scaleway.dedibox.v1.FailoverIP.Status · enum

Status of the IP failover.

Enum values:

unknown_status

ready

busy

locked

Default: unknown_status

scaleway.dedibox.v1.FailoverBlock

Block of the IP failover.

type

scaleway.dedibox.v1.FailoverIP.InterfaceType · enum

The interface type.

Enum values:

unknown

normal

ipmi

virtual

Default: unknown

server_zone

string | null

The server zone (if assigned).

Delete a failover server

DELETE

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips/{ip_id}

Delete the failover associated with the given ID.

Delete a failover server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

ip_id

integer · uint64 · required

ID of the failover IP to delete.

Delete a failover server › Responses

No data returned

Attach a failover IP to a MAC address

POST

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips/{ip_id}/attach-to-mac-address

Attach a failover IP to a MAC address › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

ip_id

integer · uint64 · required

ID of the failover IP.

Attach a failover IP to a MAC address › Request Body

type

scaleway.dedibox.v1.AttachFailoverIPToMacAddressRequest.MacType · enum

A mac type.

Enum values:

mac_type_unknown

vmware

kvm

xen

Default: mac_type_unknown

mac

string | null

A valid mac address (existing or not).

Attach a failover IP to a MAC address › Responses

200

scaleway.dedibox.v1.IP

ip_id

integer · uint64

ID of the IP.

address

string

Address of the IP. (IP address)

reverse

string

Reverse IP value.

version

scaleway.dedibox.v1.IP.Version · enum

Version of IP (v4 or v6).

Enum values:

ipv4

ipv6

Default: ipv4

cidr

integer · uint32

Classless InterDomain Routing notation of the IP.

netmask

string

Network mask of IP. (IP address)

semantic

scaleway.dedibox.v1.IP.Semantic · enum

Semantic of IP.

Enum values:

unknown

proxad

ext

public

private

ipmi

adm

redirect

Default: unknown

gateway

string

Gateway of IP. (IP address)

status

scaleway.dedibox.v1.IP.Status · enum

Status of the IP.

Enum values:

unknown_status

ready

busy

locked

Default: unknown_status

Detach a failover IP from a MAC address

POST

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips/{ip_id}/detach-from-mac-address

Detach a failover IP from a MAC address › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

ip_id

integer · uint64 · required

ID of the failover IP.

Detach a failover IP from a MAC address › Request Body

Detach a failover IP from a MAC address › Responses

200

scaleway.dedibox.v1.IP

ip_id

integer · uint64

ID of the IP.

address

string

Address of the IP. (IP address)

reverse

string

Reverse IP value.

version

scaleway.dedibox.v1.IP.Version · enum

Version of IP (v4 or v6).

Enum values:

ipv4

ipv6

Default: ipv4

cidr

integer · uint32

Classless InterDomain Routing notation of the IP.

netmask

string

Network mask of IP. (IP address)

semantic

scaleway.dedibox.v1.IP.Semantic · enum

Semantic of IP.

Enum values:

unknown

proxad

ext

public

private

ipmi

adm

redirect

Default: unknown

gateway

string

Gateway of IP. (IP address)

status

scaleway.dedibox.v1.IP.Status · enum

Status of the IP.

Enum values:

unknown_status

ready

busy

locked

Default: unknown_status

Attach failovers on baremetal server

POST

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips/attach

Attach failovers on the server associated with the given ID.

Attach failovers on baremetal server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

Attach failovers on baremetal server › Request Body

fips_ids

integer[] · required

List of ID of failovers IP to attach.

server_id

integer · uint64

ID of the server.

Attach failovers on baremetal server › Responses

No data returned

Detach failovers on baremetal server

POST

https://api.scaleway.com

/dedibox/v1/zones/{zone}/failover-ips/detach

Detach failovers on the server associated with the given ID.

Detach failovers on baremetal server › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

Detach failovers on baremetal server › Request Body

fips_ids

integer[] · required

List of IDs of failovers IP to detach.

Detach failovers on baremetal server › Responses

No data returned

Rescue Quotas