VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. Network Protection
  • 👋 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
      • List servers
      • Server status
      • Get a server
      • Server metrics
      • Bandwidth
      • Deploy new server
      • Start a server
      • Restart a server
      • Stop a server
      • Power off
      • Cancel server
      • Undo cancel request
      • Change password
      • Update hostname
      • Update SSH Keys
      • Modify ISOs
      • Restore
      • Renew server
      • Reinstall Server
      • Change Primary IP
      • Calculate renew amount
    • 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
        GET
      • Bandwidth
        GET
      • List blocked IPs
        GET
      • List attacks
        GET
      • Get an attack
        GET
      • Attack bandwidth
        GET
    • 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. Network Protection

Attack bandwidth

GET
https://api.vpsbg.eu/v1/network-protection/{id}/attacks/{attack_id}/bandwidth
Servers
This endpoint returns bandwidth data which can be based per ASN or Protocol.

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 IP Address identificator.
attack_id
string 
required
ID of the attack.
Example:
qAEbdFBBluE9bYI
Query Params
type
string 
optional
The type parameter defines how to display bandwidth data during an attack. If set to "as", each line shows bandwidth for a specific ASN. If set to "protocol", each line shows bandwidth per protocol. Both options include a total bandwidth line.
Default:
as
Example:
as
Match pattern:
^(as|protocol)$
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 --request GET 'https://api.vpsbg.eu/v1/network-protection//attacks/qAEbdFBBluE9bYI/bandwidth?type=as' \
--header 'Accept;'

Responses

🟢200Bandwidth data for an attack
application/json
Body
data
array [object {2}] 
required
timestamp
integer 
optional
lanes
array [object {3}] 
optional
Examples
{
  "data": [
    {
      "timestamp": 1727134990,
      "lanes": [
        {
          "name": "112233",
          "bandwidth": 0,
          "pps": 0
        },
        {
          "name": "112234",
          "bandwidth": 0,
          "pps": 0
        },
        {
          "name": "112235",
          "bandwidth": 0,
          "pps": 0
        },
        {
          "name": "total",
          "bandwidth": 0,
          "pps": 0
        }
      ]
    },
    {
      "timestamp": 1727135000,
      "lanes": [
        {
          "name": "112233",
          "bandwidth": 0,
          "pps": 0
        },
        {
          "name": "112234",
          "bandwidth": 0,
          "pps": 0
        },
        {
          "name": "112235",
          "bandwidth": 0,
          "pps": 0
        },
        {
          "name": "total",
          "bandwidth": 0,
          "pps": 0
        }
      ]
    }
  ]
}
🔴500Server Error
Modified at 2024-10-15 11:29:12
Previous
Get an attack
Next
List orders
Built with