Documentation

Everything you need to deploy and scale on CoolVDS

/// QUICK START

Get up and running in under 5 minutes with our quickstart guide.

Read Guide →

/// API REFERENCE

Complete API documentation for programmatic deployment and management.

View API Docs →

/// CLI TOOLS

Deploy and manage infrastructure from the command line.

Install CLI →

Quick Start Guide

1. Create an Account

2. Generate API Key

                
                    $ coolvds auth login

                    $ coolvds auth create-key --name "my-key"

3. Deploy Your First Instance

                
                    $ coolvds create \

                      --plan spark-xs \

                      --region us-west \

                      --name my-server

4. Connect via SSH


                    $ coolvds ssh my-server

API Reference

Authentication

All API requests require authentication via API key in the Authorization header:


                    Authorization: Bearer YOUR_API_KEY

List Instances


                    GET https://api.coolvds.com/v1/instances

Create Instance

                
                    POST https://api.coolvds.com/v1/instances

                    {

                      "plan": "spark-xs",

                      "region": "us-west",

                      "name": "my-server"

                    }

CLI Installation

macOS / Linux


                    $ curl -fsSL https://cli.coolvds.com/install.sh | sh

Windows


                    > iwr https://cli.coolvds.com/install.ps1 | iex

Verify Installation


                    $ coolvds version