Purchase Floating IPs

POST/floating-ips

Place an order for new Floating IP addresses. Floating IP address is a reserved IP address for you that you can manage freely - attach, detach, and cancel. Can be used for Fault Tolerance.

Account limits

Remember that every VPSBG account has a certain limit of IP addresses it can have. If you receive an error that you reached your limit, please contact us to increase it.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

billing_cycle

integer

optional

ipv4

integer

optional

Quantity of IP addresses you would like to purchase.

ipv4_ddos

integer

optional

Quantity of DDoS-Protected IP addresses you would like to purchase.

ipv6

integer

optional

Quantity of IPv6 addresses you would like to purchase.

server_id

integer

optional

If desired, you can directly attach the new IP address to a server.
Note: The server might be rebooted to apply the network settings.

{
  "billing_cycle": 1,
  "ipv4": 1,
  "ipv4_ddos": 0,
  "ipv6": 0,
  "server_id": 2478
}

Request samples

Responses

You will receive the purchased IP addresses. If you selected the option to attach them to a server, the server's will be rebooted to apply the new network settings.(200)

You will receive the purchased IP addresses. If you selected the option to attach them to a server, the server's will be rebooted to apply the new network settings.

HTTP Code: 200

Content Type : JSONapplication/json

data

array[object (Floating IP) {13}]

optional

integer

optional

Example:

status

string

optional

Status of the IP address as a service.

Example:

active

server_id

integer | null

optional

The server identification number to which this IP address is attached to.

Example:

2586

server_hostname

string

required

Server's hostname

Example:

ubuntu-2g

server_main_ip

string

required

The main IP address of the server that this Floating IP is attached to.

locked

boolean | null

required

Default:

false

locked_at

string | null

optional

Example:

2024-11-24T22:00:00.000000Z

lock_reason

string | null

required

Example:

floating-ip-attach

billing_cycle

integer

required

Example:

expiry_at

string

optional

The expiration date of the IP address.

Example:

2025-09-29T21:00:00.000000Z

plan

object

required

ip_address

object

required

The IP address object

cancel_request

object

required

{
  "data": [
    {
      "id": 614,
      "status": "processing",
      "server_id": null,
      "locked": false,
      "locked_at": null,
      "lock_reason": null,
      "billing_cycle": 1,
      "server_hostname": null,
      "expiry_at": null,
      "plan": {
        "id": 32,
        "name": "floating-ipv4",
        "available": true,
        "price": 2.5,
        "price_with_vat": 3
      },
      "ip_address": null,
      "cancel_request": null
    }
  ]
}

Last modified: 2 months ago