VPSBG's dev hub
List servers
GEThttps://api.vpsbg.eu/v1/serversList all active and suspended servers in your VPSBG account.
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.
>= 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
Request samples
Responses
List of all servers.(200)
List of all servers.
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
object (Server)
required
This model represent a VPSBG Server.
id
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:
1
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
locked
boolean
required
The server might be locked in some scenarios like creating a snapshot, backup or other operation.
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.
server_image
object
required
ip_addresses
object
required
addons
array [object {2}]
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": 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",
"locked": true,
"created_at": "2024-08-29T14:21:54.000000Z",
"expiry_at": "2024-09-28T21:00:00.000000Z",
"auto_renew": true,
"server_image": {
"id": 73,
"name": "Ubuntu 22.04",
"group": {
"name": "Ubuntu",
"type": "os",
"key": "ubuntu"
}
},
"ip_addresses": [
{
"id": 416,
"ip_address": "87.121.52.159",
"gateway": "87.121.52.1",
"mask": "255.255.255.0",
"version": 4,
"type": "public",
"main": true,
"ddos_protected": false,
"ptr": null
}
],
"addons": [
{
"name": "backups",
"quantity": 60
}
]
},
{
"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",
"locked": true,
"created_at": "2024-07-29T14:21:54.000000Z",
"expiry_at": "2024-08-28T21:00:00.000000Z",
"auto_renew": true,
"server_image": {
"id": 72,
"name": "Ubuntu 22.04",
"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": [
{
"name": "backups",
"quantity": 50
}
]
}
],
"links": {
"first": "http://api.vpsbg.eu/v1/servers?page=1",
"last": "http://api.vpsbg.eu/v1/servers?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://api.vpsbg.eu/v1/servers?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "http://api.vpsbg.eu/v1/servers",
"per_page": 50,
"to": 1,
"total": 1
}
}Last modified: 3 months ago