VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. API Reference
  2. Floating IPs
  • 👋 Hello
  • API Introduction
    • API Introduction
    • How to generate API key?
  • API Reference
    • User
      • 2FA
        • Get 2FA secret key
        • Enable 2FA
        • Disable 2FA
      • Update user
      • Get account information
    • Balance
      • Balance
      • Deposit funds
      • List balance transactions
    • Affiliate
      • Get affiliate information
      • List conversions
      • List payouts
      • Activate affiliate program
      • Update referral code
    • Invoices
      • List invoices
      • Download an invoice
      • Download invoices
    • Support
      • Tickets
        • List tickets
        • List departments
        • List related services
        • Get a ticket
        • Create new ticket
        • Reply to ticket
        • Mark ticket as resolved
        • Download attachment
      • List plans
      • Purchase support plan
      • Renew support plan
      • Cancel support plan
      • Undo cancel request
    • SSH Keys
      • Get an SSH Key
      • Update SSH Key
      • Delete SSH Key
      • List SSH keys
      • Add SSH Key
    • Servers
      • Scale
        • List plans
        • Calculate scale cost
        • Scale a server
      • Addons
        • List available addons
        • Scale addons
        • Calculate scale cost
        • Purchase new addons
        • Cancel addon
        • Undo cancel request
      • Rescue
        • Enable rescue mode
        • Disable rescue mode
      • List plans
      • List servers
      • Server status
      • Get a server
      • Server metrics
      • Bandwidth
      • Deploy new server
      • Start a server
      • Restart a server
      • Stop a server
      • Power off
      • Cancel server
      • Undo cancel request
      • Change password
      • Update hostname
      • Update SSH Keys
      • Modify ISOs
      • Restore
      • Renew server
      • Reinstall Server
      • Change Primary IP
      • Calculate renew amount
    • Plans
      • Plan addon
      • Plan promo-codes
    • Snapshots
      • List snapshots
      • Delete snapshot
    • Backups
      • List backups
      • Delete backup
    • Server Images
      • List server images
    • Floating IPs
      • List Floating IPs
        GET
      • Plans
        GET
      • Purchase Floating IPs
        POST
      • Attach Floating IP
        POST
      • Detach Floating IP
        POST
      • Cancel Floating IP
        POST
      • Delete Floating IP Cancellation
        DELETE
    • IP Addresses
      • Update IP address
    • Network Protection
      • Geo filter
        • Get current geo filter
        • Set geo filter
        • Update geo filter
        • Delete geo filter
      • Whitelist
        • Get status and list of IPs
        • Whitelist IP addresses
        • Update IP addresses list
        • Delete all rules
      • Blacklist
        • Get status and list of IPs
        • Blacklist IP addresses
        • Update IP addresses list
        • Delete all rules
      • General information
      • Bandwidth
      • List blocked IPs
      • List attacks
      • Get an attack
      • Attack bandwidth
    • Orders
      • List orders
      • Get an order
      • Delete order
      • Pay orders
      • Update order
      • Change renewal period
    • ISOs
      • Get an ISO
      • Delete an ISO
      • List ISOs
      • Add ISO
  1. API Reference
  2. Floating IPs

Purchase Floating IPs

POST
https://api.vpsbg.eu/v1/floating-ips
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
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Accept
string 
required
Default:
application/json
Body Params application/json
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.
Example
{
  "billing_cycle": 1,
  "ipv4": 1,
  "ipv4_ddos": 0,
  "ipv6": 0,
  "server_id": 2478
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vpsbg.eu/v1/floating-ips' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "billing_cycle": 1,
    "ipv4": 1,
    "ipv4_ddos": 0,
    "ipv6": 0,
    "server_id": 2478
}'

Responses

🟢200You 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.
application/json
Body
data
array[object (Floating IP) {13}] 
optional
id
integer 
optional
Example:
1
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:
3
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
Example
{
  "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
    }
  ]
}
🔴500Server Error
Modified at 2024-11-05 08:53:34
Previous
Plans
Next
Attach Floating IP
Built with