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

Server metrics

GET
https://api.vpsbg.eu/v1/servers/{id}/metrics
Servers
This endpoint will return past health data for your server - state and resource usage.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
integer 
required
VPSBG's ID of your server
Query Params
filter[month]
number 
optional
A number representing the month.
filter[year]
number 
optional
A four-digit number representing the year.
sort
string 
optional
Sorting parameter. Possible values: date (ascending), -date (descending)
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//metrics?filter[month]&filter[year]&sort' \
--header 'Accept;' \
--header 'Content-Type: text/plain' \
--data-raw ''

Responses

🟢200List of historical data points and server metrics, sorted in descending order with the newest data at the top.
application/json
Body
data
array [object {8}] 
optional
timestamp
integer 
optional
Unix timestamps when the data was captured.
running
boolean 
optional
Whether the server was running or not at the time of capturing the data.
cpu
number 
optional
CPU Usage %
network_in
number 
optional
Received traffic in MB/s.
network_out
number 
optional
Sent traffic in MB/s.
disk
number 
optional
Disk usage in GB/s.
io_read
integer 
optional
Read I/O in MB/s.
io_write
number 
optional
Write I/O in MB/s.
Example
{
  "data": [
    {
      "timestamp": 1696888806,
      "running": true,
      "cpu": 2,
      "network_in": 0.006080078125,
      "network_out": 0.000115234375,
      "disk": 3.8271484375,
      "io_read": 0,
      "io_write": 0.0106669921875
    },
    {
      "timestamp": 1696888562,
      "running": true,
      "cpu": 1.9,
      "network_in": 0.006513671875,
      "network_out": 0.00012890625,
      "disk": 3.8271484375,
      "io_read": 0,
      "io_write": 0.0026669921875
    }
  ]
}
🔴500Server Error
Previous
Get a server
Next
Bandwidth
Built with