List servers - VPSBG's dev hub

List all active and suspended servers in your VPSBG account.

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.

>= 1<= 50

filter[ip]

string

optional

Filter servers by IP address.

filter[search]

string

optional

Combined search field. Searches by IP and hostname.

filter[status]

string

optional

Filter servers by Status. Default filter is: active,suspended

sort[created_at]

string

optional

Sort by created_at field. Default is sort by newest.

sort[expiry_at]

string

optional

Sort by expirt_at field.

Header Params

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200List of all servers.

application/json

Body

data

object

required

integer

required

Internal ID of the server.

Example:

2864

hostname

string

required

Actual hostname installed on the server.

Example:

ubuntu-2gb

billing_cycle

integer

required

Example:

plan

object

required

status

string

required

This is the billing status of the server. It does not represent the technical status of the server - running, stopped, etc.

Examples:

active processing suspended terminated

virtualization

string

required

Example:

kvm

promo_code

string | null

optional

Latest used promo code.

locked

boolean

required

The server might be locked in some scenarios like creating a snapshot, backup or other operation.

locked_at

string | null

optional

lock_reason

string | null

optional

created_at

string

required

Example:

2024-08-29T14:21:54.000000Z

expiry_at

string

required

Example:

2024-10-27T11:03:10.000000Z

potential_expiry_at

string

required

Accounts for unpaid or processing renew Orders.

Example:

2024-11-27T11:03:10.000000Z

auto_renew

boolean

required

If set to true, the server will be renewed using funds from your account balance or saved credit/credit cards.

show_smtp_unblock_form

boolean

required

server_image

object

required

ip_addresses

array[object (IP address) {10}]

required

addons

array [object {8}] | null

optional

cancel_request

optional

settings

object

required

root_password_login_enabled

boolean

required

Default:

true

ssh_keys

array [object {3}]

required

app_getting_started

string | null

optional

App template getting started text. Shown only if "include" contains app_getting_started.

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

Example

{
  "data": [
    {
      "id": 2864,
      "hostname": "ubuntu-2gb",
      "billing_cycle": 1,
      "plan": {
        "id": 104,
        "type": "cloud-vps",
        "name": "cloud-vps-4gb",
        "vcpus": 2,
        "memory": 4,
        "disk": 60,
        "bandwidth": 5,
        "minimum_billing_cycle": 1,
        "available": true,
        "price": 39,
        "price_with_vat": 46.8
      },
      "status": "active",
      "virtualization": "kvm",
      "promo_code": "fall2401",
      "locked": true,
      "created_at": "2024-08-29T14:21:54.000000Z",
      "expiry_at": "2024-09-28T21:00:00.000000Z",
      "auto_renew": true,
      "show_smtp_form": true,
      "server_image": {
        "id": 73,
        "name": "Ubuntu 22.04",
        "eol": false,
        "group": {
          "name": "Ubuntu",
          "type": "os",
          "key": "ubuntu"
        }
      },
      "ip_addresses": [
        {
          "id": 10,
          "ip_address": "87.120.37.9",
          "prefix": 32,
          "version": 4,
          "type": "public",
          "main": false,
          "ddos_protected": false,
          "floating_ip": true,
          "floating_ip_id": 637,
          "ptr": null,
          "assigned_on": "2021-01-22T11:43:54.000000Z"
        },
        {
          "id": 48,
          "ip_address": "87.120.37.47",
          "prefix": 32,
          "version": 4,
          "type": "public",
          "main": true,
          "ddos_protected": false,
          "floating_ip": false,
          "floating_ip_id": null,
          "ptr": null,
          "assigned_on": "2025-03-14T11:52:22.000000Z"
        }
      ],
      "addons": [
        {
          "id": 801,
          "name": "backups",
          "status": "active",
          "quantity": 60,
          "amount": 36,
          "amount_with_vat": 43.2,
          "created_at": "2025-01-10 11:45:31",
          "ended_at": null
        },
        {
          "id": 802,
          "name": "100mbps-unmetered",
          "status": "active",
          "quantity": 1,
          "amount": 300,
          "amount_with_vat": 360,
          "created_at": "2025-01-16 14:29:56",
          "ended_at": null
        }
      ],
      "cancel_request": null,
      "settings": {
        "renew_enabled": true,
        "snapshots_enabled": true
      },
      "root_password_login_enabled": true
    },
    {
      "id": 2863,
      "hostname": "ubuntu-2gb",
      "billing_cycle": 1,
      "plan": {
        "id": 104,
        "type": "cloud-vps",
        "name": "cloud-vps-2gb",
        "vcpus": 2,
        "memory": 2,
        "disk": 50,
        "bandwidth": 5,
        "minimum_billing_cycle": 1,
        "available": true,
        "price": 22.33,
        "price_with_vat": 26.8
      },
      "status": "active",
      "virtualization": "kvm",
      "promo_code": null,
      "locked": true,
      "created_at": "2024-07-29T14:21:54.000000Z",
      "expiry_at": "2024-08-28T21:00:00.000000Z",
      "auto_renew": true,
      "show_smtp_form": false,
      "server_image": {
        "id": 72,
        "name": "Ubuntu 22.04",
        "eol": false,
        "group": {
          "name": "Ubuntu",
          "type": "os",
          "key": "ubuntu"
        }
      },
      "ip_addresses": [
        {
          "id": 417,
          "ip_address": "87.121.52.160",
          "gateway": "87.121.52.1",
          "mask": "255.255.255.0",
          "version": 4,
          "type": "public",
          "main": true,
          "ddos_protected": false,
          "ptr": null
        }
      ],
      "addons": [
        {
          "id": 801,
          "name": "backups",
          "status": "active",
          "quantity": 60,
          "amount": 36,
          "amount_with_vat": 43.2,
          "created_at": "2025-01-10 11:45:31",
          "ended_at": null
        },
        {
          "id": 802,
          "name": "100mbps-unmetered",
          "status": "active",
          "quantity": 1,
          "amount": 300,
          "amount_with_vat": 360,
          "created_at": "2025-01-16 14:29:56",
          "ended_at": null
        }
      ],
      "cancel_request": null,
      "settings": {
        "renew_enabled": true,
        "snapshots_enabled": true
      },
      "root_password_login_enabled": true
    }
  ],
  "links": {
    "first": "https://api.vpsbg.eu/v1/servers?page=1",
    "last": "https://api.vpsbg.eu/v1/servers?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/servers?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://api.vpsbg.eu/v1/servers",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

🔴500Server Error