List Floating IPs

GET/floating-ips

List of all active Floating IP addresses.

Request

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.

Request samples

Responses

List of all Floating IPs.(200)

List of all Floating IPs.

HTTP Code: 200

Content Type : JSONapplication/json

data

array [object]

required

links

object

required

first

string

required

last

string

required

null

required

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

integer

required

total

integer

required

{
  "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": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/floating-ips?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://api.vpsbg.eu/v1/floating-ips",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

Last modified: 12 days ago