# VPSBG's dev hub

## Docs
- [👋 Hello](http://dev.vpsbg.eu/doc-338630.md): 
- API Introduction [API Introduction](http://dev.vpsbg.eu/doc-338631.md): 
- API Introduction [How to generate API key?](http://dev.vpsbg.eu/doc-338632.md): 

## API Docs
- API Reference > User > 2FA [Get 2FA secret key](http://dev.vpsbg.eu/api-3578736.md): Generates a secret key and OTP URL for authenticator apps. Based on the URL, a QR code can be generated in the front-end.
- API Reference > User > 2FA [Enable 2FA](http://dev.vpsbg.eu/api-3578737.md): Enables 2FA security method for an account. Requires a secret key previously generated and a one time password to validate the process.
- API Reference > User > 2FA [Disable 2FA](http://dev.vpsbg.eu/api-3578743.md): Disable the 2FA for the account.
- API Reference > User [Update user](http://dev.vpsbg.eu/api-3578566.md): This endpoint is used to update the user's information.
- API Reference > User [Get account information](http://dev.vpsbg.eu/api-3574127.md): This endpoint will return the account information you have with us.
- API Reference > Balance [Balance](http://dev.vpsbg.eu/api-3487355.md): This endpoint returns information regarding the curent state of your balance.
- API Reference > Balance [Deposit funds](http://dev.vpsbg.eu/api-3661125.md): This endpoint provides payment instructions for depositing funds into the user's account. It supports multiple payment methods and returns the necessary details required to complete the deposit.
- API Reference > Balance [List balance transactions](http://dev.vpsbg.eu/api-3662272.md): This endpoint retrieves a list of all balance transactions associated with your VPSBG account.
- API Reference > Affiliate [Get affiliate information](http://dev.vpsbg.eu/api-3586247.md): 
- API Reference > Affiliate [List conversions](http://dev.vpsbg.eu/api-3586613.md): List all affiliate conversions.
- API Reference > Affiliate [List payouts](http://dev.vpsbg.eu/api-3586614.md): List of all affiliate payouts made to your account's balance.
- API Reference > Affiliate [Activate affiliate program](http://dev.vpsbg.eu/api-3586248.md): 
- API Reference > Affiliate [Update referral code](http://dev.vpsbg.eu/api-3586623.md): You can use this endpoint to update your affiliate referral code. You old referral links will continue to work properly.
- API Reference > Invoices [List invoices](http://dev.vpsbg.eu/api-3578754.md): List all VAT invoices for the account.
- API Reference > Invoices [Download an invoice](http://dev.vpsbg.eu/api-3578755.md): Download a single invoice.
- API Reference > Invoices [Download invoices](http://dev.vpsbg.eu/api-3578756.md): Download multiple invoices in a ZIP file.
- API Reference > Support > Tickets [List tickets](http://dev.vpsbg.eu/api-3597301.md): This endpoint returns a list of all support tickets.
- API Reference > Support > Tickets [List departments](http://dev.vpsbg.eu/api-3597302.md): Lists all available ticket departments.
- API Reference > Support > Tickets [List related services](http://dev.vpsbg.eu/api-3597303.md): Lists all related services to a ticket.
- API Reference > Support > Tickets [Get a ticket](http://dev.vpsbg.eu/api-3597304.md): This endpoint will return data regarding your ticket.
- API Reference > Support > Tickets [Create new ticket](http://dev.vpsbg.eu/api-3597305.md): This endpoint will create a new ticket in our system.
- API Reference > Support > Tickets [Reply to ticket](http://dev.vpsbg.eu/api-3597306.md): This endpoint can be used to send a new message to a ticket.
- API Reference > Support > Tickets [Mark ticket as resolved](http://dev.vpsbg.eu/api-3597307.md): This endpoint is used to "close" a ticket (mark it as resolved).
- API Reference > Support > Tickets [Download attachment](http://dev.vpsbg.eu/api-3597308.md): This endpoints downloads an attachment from a ticket message.
- API Reference > Support [List plans](http://dev.vpsbg.eu/api-3597275.md): This endpoint returns all support plans.
- API Reference > Support [Purchase support plan](http://dev.vpsbg.eu/api-3597276.md): This endpoint will create a new order for the selected support plan. After payment, the support plan will be activated.
- API Reference > Support [Renew support plan](http://dev.vpsbg.eu/api-3597277.md): This endpoint allows you to place an order for support plan renewal.
- API Reference > Support [Cancel support plan](http://dev.vpsbg.eu/api-3597298.md): This endpoint can be used to send a cancel request for an active support plan.
- API Reference > Support [Undo cancel request](http://dev.vpsbg.eu/api-3597299.md): This endpoint will undo the cancel request of your support plan and you can continue to use this service.
- API Reference > SSH Keys [Get an SSH Key](http://dev.vpsbg.eu/api-3487359.md): Get an existing SSH Key, registered in your account.
- API Reference > SSH Keys [Update SSH Key](http://dev.vpsbg.eu/api-3487360.md): You can update a saved SSH key. If the value of some input is empty, it will retain its original value. Updating your SSH key will not update the ssh key on your previously deployed servers.
- API Reference > SSH Keys [Delete SSH Key](http://dev.vpsbg.eu/api-3487361.md): Deleting your SSH Key from your VPSBG profile will not remove it from the servers where it was already deployed.
- API Reference > SSH Keys [List SSH keys](http://dev.vpsbg.eu/api-3487362.md): List all SSH Keys saved in your account.
- API Reference > SSH Keys [Add SSH Key](http://dev.vpsbg.eu/api-3487363.md): You can save a new SSH key and use it to deploy future servers.
- API Reference > Servers > Scale [List plans](http://dev.vpsbg.eu/api-3600025.md): This endpoint will return information about available server plans to which you can scale to. It filters all server plans that are with less disk space than your current server's disk space.
- API Reference > Servers > Scale [Calculate scale cost](http://dev.vpsbg.eu/api-3600501.md): You can use this endpoint to calculate the cost (when upgrading) or the refund amount (when downgrading). It also provides information about the estimated downtime to complete the process.
- API Reference > Servers > Scale [Scale a server](http://dev.vpsbg.eu/api-3603457.md): You can use this endpoint to scale (upgrade or downgrade) your server. If you previously upscaled your server without a disk upgrade, then you can use this method to bring your disk size to the plan's disk limit by sending the same plan and scale_disk - true.
- API Reference > Servers > Addons [List available addons](http://dev.vpsbg.eu/api-3620169.md): This endpoint will return a list of all purchasable addons for your server with the price, calculated for your server configuration.
- API Reference > Servers > Addons [Scale addons](http://dev.vpsbg.eu/api-3613822.md): You can use this endpoint to scale (upgrade or downgrade) your addons. 
- API Reference > Servers > Addons [Calculate scale cost](http://dev.vpsbg.eu/api-3613904.md): You can use this endpoint to calculate the cost (when upgrading) or the refund to your balance (when downgrading).
- API Reference > Servers > Addons [Purchase new addons](http://dev.vpsbg.eu/api-3620180.md): You can use this endpoint to activate new addons for your server.
- API Reference > Servers > Addons [Cancel addon](http://dev.vpsbg.eu/api-3621295.md): Send a cancel request for your server addon. This *won't* terminate your server addon. The server addon is being terminated later, depending whether you cancel your server addon immediately or at the end of the billing period.
- API Reference > Servers > Addons [Undo cancel request](http://dev.vpsbg.eu/api-3645414.md): This endpoint allows you to remove/undo a previously made cancel request for your server addon.
- API Reference > Servers > Rescue [Enable rescue mode](http://dev.vpsbg.eu/api-3662083.md): Rescue mode allows you to boot your virtual machine into a minimal Linux environment for troubleshooting and recovery. When enabling rescue mode, a password for the Linux Rescue environment is required. Once initiated, the VM will automatically boot into Rescue mode within 1-2 minutes, providing access to the system for diagnostics, repairs, or data recovery.
- API Reference > Servers > Rescue [Disable rescue mode](http://dev.vpsbg.eu/api-3662220.md): This endpoint allows you to disable rescue mode for a virtual machine. Once disabled, the VM will automatically boot into its primary operating system within 1-2 minutes.
- API Reference > Servers [List plans](http://dev.vpsbg.eu/api-3579655.md): This endpoint will return list with server plans that can be used for new deployments.
- API Reference > Servers [List servers](http://dev.vpsbg.eu/api-3487364.md): List all active and suspended servers in your VPSBG account.
- API Reference > Servers [Server status](http://dev.vpsbg.eu/api-3487366.md): This endpoint will return live information about your server.
- API Reference > Servers [Get a server](http://dev.vpsbg.eu/api-3487367.md): This endpoint will return data regarding your server.
- API Reference > Servers [Server metrics](http://dev.vpsbg.eu/api-3487368.md): This endpoint will return past health data for your server - state and resource usage.
- API Reference > Servers [Bandwidth](http://dev.vpsbg.eu/api-3582800.md): This endpoint return bandwidth information for the selected server.
- API Reference > Servers [Deploy new server](http://dev.vpsbg.eu/api-3487365.md): This endpoints creates a new order for a server and pays it off-session using your account's balance or performs a payment directly from your saved card.
- API Reference > Servers [Start a server](http://dev.vpsbg.eu/api-3487369.md): Send a start command to your server.
- API Reference > Servers [Restart a server](http://dev.vpsbg.eu/api-3487370.md): Send a restart command to your server.
- API Reference > Servers [Stop a server](http://dev.vpsbg.eu/api-3487371.md): Send a command to your server to stop gracefully. 
- API Reference > Servers [Power off](http://dev.vpsbg.eu/api-3487374.md): Perform a hard shutdown. This operation is not recommended as it may break the file system of your server.
- API Reference > Servers [Cancel server](http://dev.vpsbg.eu/api-3487375.md): Send a cancel request for your server. This *won't* terminate your server. The servers are being terminated later, depending whether you cancel your server immediately or at the end of the billing period.
- API Reference > Servers [Undo cancel request](http://dev.vpsbg.eu/api-3601172.md): This endpoint allows you to remove/undo a previously made cancel request for your server.
- API Reference > Servers [Change password](http://dev.vpsbg.eu/api-3487373.md): Update the administrator password for your server. For Linux-based servers, this will change the root password and for Windows-based servers, it will change the password for the Administrator user. A reboot is required to apply the changes.
- API Reference > Servers [Update hostname](http://dev.vpsbg.eu/api-3487372.md): Update the hostname of your server. The new hostname will be applied in your server after a reboot.
- API Reference > Servers [Update SSH Keys](http://dev.vpsbg.eu/api-3739086.md): This endpoint will update the SSH Keys on your server. The change requires reboot of the server.
- API Reference > Servers [Modify ISOs](http://dev.vpsbg.eu/api-3666429.md): This endpoint assigns a primary ISO and an optional secondary ISO to a server.
- API Reference > Servers [Restore](http://dev.vpsbg.eu/api-3709103.md): This API endpoint triggers a server restore process from a specified snapshot or backup. Please specify snapshot_id OR backup_id.
- API Reference > Servers [Renew server](http://dev.vpsbg.eu/api-3709535.md): Creates renew order for your server.
- API Reference > Servers [Reinstall Server](http://dev.vpsbg.eu/api-3749659.md): This endpoint can be used if you want to reinstall your server. 
- API Reference > Servers [Change Primary IP](http://dev.vpsbg.eu/api-3755895.md): This endpoint changes the primary IP address of a virtual server. The new IP address replaces the current primary IP assigned to the main network interface. 
- API Reference > Servers [Calculate renew amount](http://dev.vpsbg.eu/api-3759409.md): Returns the amount needed for servers renew for a given period and promo code.
- API Reference > Plans [Plan addon](http://dev.vpsbg.eu/api-3650644.md): List available addons for a specified plan.
- API Reference > Plans [Plan promo-codes](http://dev.vpsbg.eu/api-3650646.md): List available promo-codes for a specified plan.
- API Reference > Snapshots [List snapshots](http://dev.vpsbg.eu/api-3487377.md): List all server snapshots available.
- API Reference > Snapshots [Delete snapshot](http://dev.vpsbg.eu/api-3709101.md): This endpoint is used for deleting snapshot from our servers. This action is irreversible.
- API Reference > Backups [List backups](http://dev.vpsbg.eu/api-3487378.md): List all servers backups.
- API Reference > Backups [Delete backup](http://dev.vpsbg.eu/api-3709158.md): This endpoint is used for deleting backup from our servers. This action is irreversible.
- API Reference > Server Images [List server images](http://dev.vpsbg.eu/api-3487379.md): List all server images (operating system or app templates) that can be used for deploying new server.
- API Reference > Floating IPs [List Floating IPs](http://dev.vpsbg.eu/api-3487380.md): List of all active Floating IP addresses.
- API Reference > Floating IPs [Plans](http://dev.vpsbg.eu/api-3579661.md): List of all available Floating IP plans.
- API Reference > Floating IPs [Purchase Floating IPs](http://dev.vpsbg.eu/api-3487381.md): Place an order for new Floating IP addresses. Floating IP address is a reserved IP address for you that you can manage freely - attach, detach, and cancel. Can be used for Fault Tolerance.
- API Reference > Floating IPs [Attach Floating IP](http://dev.vpsbg.eu/api-3487382.md): Initiating a process that will attach the Floating IPs to the given server. The process will require a server reboot which you can perform later.
- API Reference > Floating IPs [Detach Floating IP](http://dev.vpsbg.eu/api-3487383.md): Starting a process to detach the provided Floating IPs from its current server. A restart, which you can do later, is needed. The IP address will lose connection immediately, and the server's network interface for this IP will reset after rebooting.
- API Reference > Floating IPs [Cancel Floating IP](http://dev.vpsbg.eu/api-3487384.md): Canceling Floating IPs means that those IPs will be terminated from your VPSBG account. If the IP addresses are attached to a server, this server will be rebooted to remove the IP address from the configuration.
- API Reference > Floating IPs [Delete Floating IP Cancellation](http://dev.vpsbg.eu/api-3588796.md): When you request a cancellation at the end of the billing cycle, you can delete it and retain your Floating IP.
- API Reference > IP Addresses [Update IP address](http://dev.vpsbg.eu/api-3579669.md): This endpoint is used to update the IP address information.
- API Reference > Network Protection > Geo filter [Get current geo filter](http://dev.vpsbg.eu/api-3593615.md): This endpoint returns the current geo filter settings - country list and the policy (deny or allow).
- API Reference > Network Protection > Geo filter [Set geo filter](http://dev.vpsbg.eu/api-3593909.md): This endpoint is setting countries in the geo filter and the desired policy - allow or deny.
- API Reference > Network Protection > Geo filter [Update geo filter](http://dev.vpsbg.eu/api-3596786.md): This endpoint can update the country list and the policy (allow or deny). You can use it if you want just to add or delete specific countries to/from the list, it's not needed to send the full final list of countries.
- API Reference > Network Protection > Geo filter [Delete geo filter](http://dev.vpsbg.eu/api-3593910.md): With this endpoint you DELETE all countries from your list and disable the geo filter entirely.
- API Reference > Network Protection > Whitelist [Get status and list of IPs](http://dev.vpsbg.eu/api-3596770.md): This endpoint returns the current state of the whitelist module and all IP addresses added to this list.
- API Reference > Network Protection > Whitelist [Whitelist IP addresses](http://dev.vpsbg.eu/api-3596771.md): This endpoint allows you to set a final list of IP addresses in the whitelist.
- API Reference > Network Protection > Whitelist [Update IP addresses list](http://dev.vpsbg.eu/api-3596772.md): This endpoint allows you to add and remove specific IP addresses from the list. Also you can switch the status of the whitelist module.
- API Reference > Network Protection > Whitelist [Delete all rules](http://dev.vpsbg.eu/api-3596773.md): This endpoint will delete all whitelist rules and disable the whitelist module for your DDoS Protected IP.
- API Reference > Network Protection > Blacklist [Get status and list of IPs](http://dev.vpsbg.eu/api-3595283.md): This endpoint returns the current state of the blacklist module and all IP addresses added to this list.
- API Reference > Network Protection > Blacklist [Blacklist IP addresses](http://dev.vpsbg.eu/api-3595285.md): This endpoint allows you to set a final list of IP addresses in the blacklist.
- API Reference > Network Protection > Blacklist [Update IP addresses list](http://dev.vpsbg.eu/api-3595326.md): This endpoint allows you to add and remove specific IP addresses from the list. Also you can switch the status of the blacklist module.
- API Reference > Network Protection > Blacklist [Delete all rules](http://dev.vpsbg.eu/api-3595284.md): This endpoint will delete all blacklist rules and disable the blacklist module for your DDoS Protected IP.
- API Reference > Network Protection [General information](http://dev.vpsbg.eu/api-3596831.md): This endpoint returns general information about the DDos Protected IP address.
- API Reference > Network Protection [Bandwidth](http://dev.vpsbg.eu/api-3592942.md): This endpoint return traffic information for the IP address after being filtered by the DDoS Filter.
- API Reference > Network Protection [List blocked IPs](http://dev.vpsbg.eu/api-3596792.md): This endpoint returns a list of blocked IPs and the reason for being blocked. All IP addresses are temporarily blocked for a minimum of 1 hour. If the IP address continue to match specific anti-DDoS filters, the block time might be extended.
- API Reference > Network Protection [List attacks](http://dev.vpsbg.eu/api-3593101.md): This endpoint returns the attacks towards this IP address. The ongoing attacks are also returned.
- API Reference > Network Protection [Get an attack](http://dev.vpsbg.eu/api-3593141.md): This endpoint return more information about a single attack.
- API Reference > Network Protection [Attack bandwidth](http://dev.vpsbg.eu/api-3593297.md): This endpoint returns bandwidth data which can be based per ASN or Protocol.
- API Reference > Orders [List orders](http://dev.vpsbg.eu/api-3644442.md): List all available orders in your VPSBG account.
- API Reference > Orders [Get an order](http://dev.vpsbg.eu/api-3644443.md): This endpoint will return data regarding your order.
- API Reference > Orders [Delete order](http://dev.vpsbg.eu/api-3644546.md): This action will mark the order as canceled. It is irreversible and will render the order unusable. Note that only orders that are not yet paid could be marked as cancelled.
- API Reference > Orders [Pay orders](http://dev.vpsbg.eu/api-3644654.md): With this endpoint you can pay multiple orders at once.
- API Reference > Orders [Update order](http://dev.vpsbg.eu/api-3644547.md): This endpoint is used to update the order's information.
- API Reference > Orders [Change renewal period](http://dev.vpsbg.eu/api-3644655.md): This endpoint is used to change the renew order's period.
- API Reference > ISOs [Get an ISO](http://dev.vpsbg.eu/api-3665876.md): Fetch details of a specific ISO file by its ID.
- API Reference > ISOs [Delete an ISO](http://dev.vpsbg.eu/api-3665878.md): Manually delete an ISO file before its scheduled deletion time.
- API Reference > ISOs [List ISOs](http://dev.vpsbg.eu/api-3665879.md): Retrieve a list of all ISO files, including their statuses and scheduled deletions.
- API Reference > ISOs [Add ISO](http://dev.vpsbg.eu/api-3665880.md): Create a new ISO file by providing a valid direct download URL. The system will start downloading the file automatically.