Suble.io API v2 Documentation

Welcome to the Suble.io API v2 documentation. This comprehensive guide covers all available endpoints for managing your cloud infrastructure, virtual machines, and billing through our modern REST API.

The Suble.io Cloud API v2 operates using the HTTPS protocol and utilizes JSON for its data format. This means all requests either submitting data or requesting data are expected to use the JSON format.

Base URL

https://api.suble.io/v2

Authorization

For authorization, the API uses the Bearer Authentication standard to implement JWT tokens. All authenticated requests must include the authorization header with your access token.

Authentication Methods

User Token (JWT)

User tokens provide full access to your account and all projects you're a member of. These tokens have a limited lifespan and must be refreshed periodically.

Authorization Header:

Authorization: Bearer <user_access_token>

Authentication Flow

1. Sign up or log in to obtain access and refresh tokens
2. Use the access token for authenticated requests
3. Refresh the access token when it expires using the refresh token

⚠️ Important: Keep your tokens secure and never expose them in client-side code or public repositories.

Documentation Sections

🔐 Authentication

• Sign up and log in
• Token management
• Profile updates
• Password reset

📁 Projects

• Create and manage projects
• Project settings
• Team collaboration

🖥️ Virtual Private Servers

• Virtual Machines - Deploy VMs and list VMs
• Management - Start, stop, reboot, console access
• Networking - IP addresses and PTR records
• Firewall - Security rules and policies
• Advanced Operations - Rebuild, resize, delete

💳 Billing & Profile

• Current billing information
• Invoice history
• Payment methods
• Billing details

📚 API Reference

• Error responses
• Rate limiting
• Support information

Quick Start

1. Create an account using the Authentication endpoint
2. Get your project from the Projects endpoint
3. Deploy a VM using the Virtual Machines endpoint
4. Manage your VM with the VM Management endpoints

System Information

List VPS Packages

GET /packages

Retrieve all available VPS packages with their specifications and pricing.

Response

200 - Success

{
  "vps": [
    {
      "type": "CRA",
      "name": "Basic",
      "price": 49,
      "vCores": 1,
      "memory": 1024,
      "storage": 25000,
      "internet": 100
    },
    {
      "type": "CRA", 
      "name": "Standard",
      "price": 99,
      "vCores": 2,
      "memory": 2048,
      "storage": 50000,
      "internet": 200
    }
  ]
}

Support

For API support, questions, or feature requests:

• Documentation: https://docs.suble.io
• Support Portal: https://support.suble.io
• Status Page: https://status.suble.io

Our support team is available to help you integrate with the Suble.io API and resolve any technical issues you may encounter.