VPSBG's dev hub
HomePricingKnowledge BaseContact us
HomePricingKnowledge BaseContact us
  1. API Introduction
  • 👋 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
      • Get 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
      • Get a snapshot
      • List snapshots
      • Delete snapshot
    • Backups
      • Get a backup
      • 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. API Introduction

How to generate API key?

In order to consume our API, you would need to generate an API key. Generating an API key can be performed via the client area.

Steps for generating an API key:

  1. Sign in to your VPSBG account from here: https://secure.vpsbg.eu/login
  2. Click on your user name and then select API tokens.
  3. You will see a screen with all API tokens you have. Press on the button, give it a name and permissions.
    NOTE: Read permission means that this API key will be able to send only GET requests to our API, while having Write allows all calls to the API.
  4. The API key will be generated successfully and you will see it only once on our platform. Please copy it and save it to a safe place.

CAUTION

Leaking your API key can have serious consequences, including unauthorized access to your data and potential misuse of our services. Therefore, we strongly advise you to exercise caution and refrain from sharing your API key with anyone.

Managing your API keys

On the same page, you can see all generated API keys you have, when was the last time each key was used and what privileges it has. You have the ability to destroy an API key which will disable the access instantly.

Modified at 2024-09-16 11:48:36
Previous
API Introduction
Next
Get 2FA secret key
Built with