VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. Addons
  • 👋 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
          GET
        • Scale addons
          PATCH
        • Calculate scale cost
          POST
        • Purchase new addons
          POST
        • Cancel addon
          POST
        • Undo cancel request
          DELETE
      • 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. Addons

Purchase new addons

POST
https://api.vpsbg.eu/v1/servers/{server_id}/addons
Addons
You can use this endpoint to activate new addons for your server.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
server_id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Body Params application/json
backups
boolean  | null 
optional
Automatic backups addon. Additional charge will occur. Your server will have weekly backups (retention 3 weeks).
cpanel
string  | null 
optional
Specify if you want a cPanel license for your server. Available licenses: cpanel-admin-5, cpanel-pro-30, cpanel-plus-50 or cpanel-premier-100. For pricing, please refer to our product page.
Example:
cpanel-admin-5
bandwidth
string  | null 
optional
Specify if you want unmetered bandwidth for your server. Available options: 100mbps-unmetered or 1gbps-unmetered. For pricing, please refer to our product page.
Example:
100mbps-unmetered
microsoft_rds_sal
integer  | null 
optional
Number of Microsoft RDS SALs you would like to purchase. The license type is Per User - users using RDS on your Windows Server. For pricing, please refer to our product page.
microsoft_office_sal
integer  | null 
optional
Number of Microsoft Office (365) SALs you would like to purchase. The license type is Per User - users using Office (365) on your Windows Server. For pricing, please refer to our product page.
Example
{
    "backups": true,
    "cpanel": "cpanel-admin-5",
    "bandwidth": "100mbps-unmetered",
    "microsoft_rds_sal": 0,
    "microsoft_office_sal": 0
}

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 POST 'https://api.vpsbg.eu/v1/servers//addons' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "backups": true,
    "cpanel": "cpanel-admin-5",
    "bandwidth": "100mbps-unmetered",
    "microsoft_rds_sal": 0,
    "microsoft_office_sal": 0
}'

Responses

🟢200Success
application/json
Body
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": 2883,
    "hostname": "ubuntu-2gb",
    "billing_cycle": 3,
    "plan": {
        "id": 105,
        "type": "cloud-vps",
        "key": "cloud-vps-8gb",
        "name": "cloud-vps-8gb",
        "vcpus": 4,
        "dedicated_cpu": false,
        "memory": 8,
        "disk": 80,
        "bandwidth": 10,
        "minimum_billing_cycle": 1,
        "plan_with_more_disk": null,
        "plan_with_more_memory": null,
        "available": true,
        "price": 78,
        "price_with_vat": 93.6
    },
    "status": "active",
    "locked": false,
    "locked_at": null,
    "lock_reason": null,
    "created_at": "2024-10-22T12:54:59.000000Z",
    "expiry_at": "2024-12-19T22:00:00.000000Z",
    "potential_expiry_at": "2024-12-19T22:00:00.000000Z",
    "auto_renew": true,
    "server_image": {
        "id": 73,
        "name": "Ubuntu 22.04",
        "group": {
            "name": "Ubuntu",
            "type": "os",
            "key": "ubuntu"
        }
    },
    "ip_addresses": [
        {
            "id": 417,
            "ip_address": "87.121.52.160",
            "prefix": 32,
            "version": 4,
            "type": "public",
            "main": true,
            "ddos_protected": false,
            "floating_ip": false,
            "ptr": null,
            "assigned_on": "2024-10-22T12:54:59.000000Z"
        }
    ],
    "addons": [
        {
            "id": 774,
            "name": "microsoft-office-sal",
            "status": "active",
            "quantity": 3,
            "amount": 180,
            "amount_with_vat": 216,
            "created_at": "2024-10-24 12:34:10"
        },
        {
            "id": 775,
            "name": "cpanel-pro-30",
            "status": "active",
            "quantity": 1,
            "amount": 105,
            "amount_with_vat": 126,
            "created_at": "2024-11-21 14:49:41"
        },
        {
            "id": 776,
            "name": "windows-server-license",
            "status": "active",
            "quantity": 2,
            "amount": 60,
            "amount_with_vat": 72,
            "created_at": "2024-11-25 15:28:50"
        },
        {
            "id": 777,
            "name": "backups",
            "status": "active",
            "quantity": 60,
            "amount": 18,
            "amount_with_vat": 21.6,
            "created_at": "2024-11-26 19:00:48"
        }
    ]
}
🟠400Bad request (specified in the response)
🟠422Validation error (specified in the response)
🔴500Server Error
Previous
Calculate scale cost
Next
Cancel addon
Built with