VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. Servers
  • 👋 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
        GET
      • List servers
        GET
      • Server status
        GET
      • Get a server
        GET
      • Server metrics
        GET
      • Bandwidth
        GET
      • Deploy new server
        POST
      • Start a server
        POST
      • Restart a server
        POST
      • Stop a server
        POST
      • Power off
        POST
      • Cancel server
        POST
      • Undo cancel request
        DELETE
      • Change password
        PUT
      • Update hostname
        PUT
      • Update SSH Keys
        PATCH
      • Modify ISOs
        POST
      • Restore
        POST
      • Renew server
        POST
      • Reinstall Server
        POST
      • Change Primary IP
        POST
      • Calculate renew amount
        POST
    • 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
      • Plans
      • Purchase Floating IPs
      • Attach Floating IP
      • Detach Floating IP
      • Cancel Floating IP
      • Delete Floating IP Cancellation
    • 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. Servers

Get a server

GET
https://api.vpsbg.eu/v1/servers/{id}
Servers
This endpoint will return data regarding your server.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
integer 
required
Your server's ID.
Query Params
include[]
array[string] | null 
optional
This parameter allows you to specify additional fields that should be embedded in the API response. Supported values: app_getting_started
Example:
["app_getting_started"]
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/servers/?include[]=app_getting_started' \
--header 'Accept;'

Responses

🟢200Returns the server model
application/json
Body
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
id
integer 
optional
Example:
104
type
string 
optional
The VDS servers have dedicated CPU cores. Cloud VPS is using shared CPU power.
Example:
cloud-vps
key
string 
optional
name
string 
optional
Example:
cloud-vps-2gb
vcpus
integer 
optional
CPU cores limit. Dedicated, if it is a VDS product.
Example:
2
memory
integer 
optional
RAM of the server.
Example:
2
disk
integer 
optional
NVMe disk size limit in gigabytes.
Example:
50
bandwidth
integer 
optional
Traffic limit in terabytes.
Example:
5
minimum_billing_cycle
integer 
optional
The minimum billing period for which this plan can be purchased.
Example:
1
plan_with_more_disk
integer  | null 
optional
The same plan but with more disk (usually 2x).
plan_with_more_memory
integer  | null 
optional
The same plan but with more RAM (usually 2x).
available
boolean 
optional
Whether in stock or not.
price
number 
optional
Monthly price without VAT adjustments.
Example:
100
price_with_vat
number 
optional
Monthly prices adjusted for your VAT when applicable; use a promo code when ordering servers for discounts, or one may be automatically applied during promotional periods for your billing cycle.
Example:
120
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
running
boolean  | null 
optional
virtualization
string 
required
Example:
kvm
promo_code
string  | null 
optional
Latest used promo code.
renew_amount
number 
required
The amount needed to renew your server for the current period.
renew_amount_with_vat
number 
required
Renew amount with vat if applicable.
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
id
integer 
required
Example:
73
name
string 
required
Example:
Ubuntu 22.04
group
object 
required
ip_addresses
array[object (IP address) {10}] 
required
id
integer 
required
Example:
417
ip_address
string 
required
The IP address.
Example:
87.120.37.46
prefix
integer 
required
Examples:
3264
version
integer 
required
Example:
4
type
string 
required
Example:
public
main
boolean 
required
ddos_protected
boolean 
required
Whether the IP is DDoS protected or not.
floating_ip
optional
Whether or not this IP is sold as a Floating IP.
ptr
object  | null 
optional
assigned_on
string 
required
Datetime when the IP address was assigned to your account.
addons
array [object {8}]  | null 
optional
id
integer 
required
name
string 
required
Default:
100mbps-unmetered
Example:
100mbps-unmetered
status
string 
required
Default:
active
Examples:
activesuspendedcancelled
quantity
integer 
required
Default:
1
Example:
1
amount
number 
required
Default:
50
Example:
50
amount_with_vat
number 
required
Default:
60
Example:
60
created_at
string 
required
Default:
2025-01-16 14:29:56
Example:
2025-01-16 14:29:56
ended_at
string 
required
cancel_request
optional
Any of
id
integer 
required
Example:
1
now
integer 
required
Canceled now or at the end of the billing cycle.
Example:
1
reason
string 
optional
Reason given by the user for the cancelation.
created_at
string 
required
Date of creation.
settings
object 
required
renew_enabled
boolean 
required
Default:
true
snapshots_enabled
boolean 
required
Default:
true
root_password_login_enabled
boolean 
required
Default:
true
ssh_keys
array [object {3}] 
required
id
integer 
optional
name
string 
optional
key
string 
optional
app_getting_started
string  | null 
optional
App template getting started text. Shown only if "include" contains app_getting_started.
Example
{
    "id": 2864,
    "hostname": "ubuntu-2gb",
    "billing_cycle": 1,
    "plan": {
        "id": 104,
        "type": "cloud-vps",
        "key": "string",
        "name": "cloud-vps-2gb",
        "vcpus": 2,
        "memory": 2,
        "disk": 50,
        "bandwidth": 5,
        "minimum_billing_cycle": 1,
        "plan_with_more_disk": 0,
        "plan_with_more_memory": 0,
        "available": true,
        "price": 100,
        "price_with_vat": 120
    },
    "status": "active",
    "virtualization": "kvm",
    "promo_code": null,
    "renew_amount": 100,
    "renew_amount_with_vat": 120,
    "locked": true,
    "created_at": "2024-08-29T14:21:54.000000Z",
    "expiry_at": "2024-10-27T11:03:10.000000Z",
    "potential_expiry_at": "2024-11-27T11:03:10.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,
    "ssh_keys": [
        {
            "id": 1,
            "name": "example",
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDxrt67sVW/ulVJdLOjUiE7pbYXoW1xhXgkRsKRIp9vBLNT5LDG0ODtu2Jhin3w/HbQvxOTfrCp2N1uS619JnAT9xev50/s7/FbfHnpjdeUoR98GDfM0Eg/qOURvtQUHjNQjD1nsm2qlsJ4eCm0fjVsKyW4QdM26CHodyzMP32c8WG4EenRNRUm3XI6vuaDbYTQmSw7lVgz6Jv6Ogp5XSeeCrHbe6XPJnssEbblDLQHfp/hgr+16VByss+ZGyKUxbsChha8NfYW/1Xn8wzns8+1zLjLkBRSgTYW848Io+C5OO87HJQgsI062EE3+TTsm/p8SWJYXxuVpvBT0J/MmtxF"
        }
    ]
}
🔴500Server Error
Previous
Server status
Next
Server metrics
Built with