VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. 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. Floating IPs

List Floating IPs

GET
https://api.vpsbg.eu/v1/floating-ips
Floating IPs
List of all active Floating IP addresses.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
page
integer 
optional
Which page of paginated results to return.
per_page
integer 
optional
How many results per page to be shown.
filter[ip]
string 
optional
Filter servers by IP address.
filter[search]
string 
optional
Combined search field. Searches by IP and by server's hostname (if attached).
filter[status]
string 
optional
Filter servers by Status. Default filter is: active,suspended
filter[ddos]
boolean 
optional
Filter wether the IP is DDoS protected or not.
Header Params
Accept
string 
required
Default:
application/json

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 -g --request GET 'https://api.vpsbg.eu/v1/floating-ips?page&per_page&filter[ip]&filter[search]&filter[status]&filter[ddos]' \
--header 'Accept;'

Responses

🟢200List of all Floating IPs.
application/json
Body
data
array [object {13}] 
required
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
links
object 
required
first
string 
required
last
string 
required
prev
null 
required
next
null 
required
meta
object 
required
current_page
integer 
required
from
integer 
required
last_page
integer 
required
links
array [object {3}] 
required
path
string 
required
per_page
integer 
required
to
integer 
required
total
integer 
required
Example
{
    "data": [
        {
            "id": 602,
            "status": "active",
            "server_id": null,
            "server_hostname": null,
            "server_main_ip": null,
            "locked": false,
            "locked_at": null,
            "lock_reason": null,
            "billing_cycle": 1,
            "expiry_at": "2024-10-15T21:00:00.000000Z",
            "plan": {
                "id": 32,
                "name": "floating-ipv4",
                "available": true,
                "price": 2.5,
                "price_with_vat": 3
            },
            "ip_address": {
                "id": 47,
                "ip_address": "87.120.37.46",
                "prefix": 32,
                "version": 4,
                "type": "public",
                "main": false,
                "ddos_protected": false,
                "ptr": {
                    "87.120.37.46": "example.com"
                }
            },
            "cancel_request": {
                "id": 233,
                "type": 1,
                "reason": "Example reason.",
                "created_at": "2024-09-25T14:16:15.000000Z"
            }
        },
        {
            "id": 608,
            "status": "active",
            "server_id": null,
            "server_hostname": null,
            "server_main_ip": null,
            "locked": false,
            "locked_at": null,
            "lock_reason": null,
            "billing_cycle": 1,
            "expiry_at": "2024-10-25T12:25:04.000000Z",
            "plan": {
                "id": 32,
                "name": "floating-ipv4",
                "available": true,
                "price": 2.5,
                "price_with_vat": 3
            },
            "ip_address": {
                "id": 416,
                "ip_address": "87.121.52.159",
                "prefix": 32,
                "version": 4,
                "type": "public",
                "main": false,
                "ddos_protected": false,
                "ptr": null
            },
            "cancel_request": {
                "id": 234,
                "type": 1,
                "reason": "Example reason.",
                "created_at": "2024-09-25T14:16:16.000000Z"
            }
        }
    ],
    "links": {
        "first": "https://api.vpsbg.eu/v1/floating-ips?page=1",
        "last": "https://api.vpsbg.eu/v1/floating-ips?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://api.vpsbg.eu/v1/floating-ips?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://api.vpsbg.eu/v1/floating-ips",
        "per_page": 50,
        "to": 1,
        "total": 1
    }
}
🔴500Server Error
Previous
List server images
Next
Plans
Built with