Start here

Getting Started

Account → credentials → first VM → live deploy in under five minutes. No local Terraform install. Every step below is shown in curl, Python and TypeScript — pick your tab.

1# 1 · install the CLI and log in   ·   all installers: https://vxcloud.io/download/cli
2curl -fsSL https://vxcloud.io/download/cli/install.sh | sh   # macOS/Linux → ~/.local/bin (no sudo)
3# Windows (PowerShell):  irm https://vxcloud.io/download/cli/install.ps1 | iex
4vxcli auth login --token vtx_live_xxx
5 
6# 2 · provision + deploy in one shot
7vxcli provision vm --cloud aws --region us-east-1 --type t3.medium
8vxcli deploy container --image nginx:latest --port 80
9 
10# 3 · watch it
11vxcli services status --follow

✨

In a hurry?

This single block does what steps 1–5 below do. The detailed walkthrough explains each call and shows the raw API and SDK equivalents.

zero → deployed

vxcli · ~5 min

Test without spending cloud money

Tokens prefixed xc_test_* run every call against the sandbox: provisioning is simulated, responses are real-shaped, and nothing is billed. Swap to xc_live_* when you're ready to provision real infrastructure.

Prerequisites

A cloud account (AWS, GCP, or Azure)
That provider’s API keys / service-account credentials
curl, or any HTTP client (Postman, Insomnia)
Optional: Node.js 18+ for the vxcli CLI / SDKs

Create your account & generate an API token

Sign up at vxcloud.io, confirm your email, create your first workspace, and generate a developer API token — the key for every subsequent call.

1# Workspace setup endpoints are public — no auth required
2curl -X POST https://api.vxcloud.io/api/v2/setup/workspace \
3  -H "Content-Type: application/json" \
4  -d '{ "workspace_name": "my-org", "region": "us-east-1" }'
5 
6curl -X POST https://api.vxcloud.io/api/v2/setup/api-token \
7  -H "Content-Type: application/json" \
8  -d '{ "token_name": "ci-bot", "expires_in_days": 90 }'

POST /api/v2/setup/workspace

X-API-Key · JSON

Workspace setup endpoints are public (no auth required).
The returned token is shown once — store it in a secret manager.
Pass it on every later request via the X-API-Key header.

Connect a cloud provider

Store cloud credentials encrypted in Vault. AWS, GCP and Azure are supported out of the box and are only decrypted at provisioning time.

1curl -X POST https://api.vxcloud.io/api/v2/setup/aws-credentials \
2  -H "Content-Type: application/json" \
3  -d '{
4    "access_key_id": "AKIA...",
5    "secret_access_key": "...",
6    "region": "us-east-1"
7  }'

POST /api/v2/setup/{aws|gcp|azure}-credentials

X-API-Key · JSON

AWS: access_key_id + secret_access_key + region.
GCP: project_id + service_account_key JSON.
Azure: client_id, client_secret, tenant_id, subscription_id.

Provision your first VM

Call /api/v2/tenant/provision/vm to spin up a VM on any connected cloud. Terraform state, SSH keys and networking are handled for you.

1curl -X POST https://api.vxcloud.io/api/v2/tenant/provision/vm \
2  -H "X-API-Key: vtx_live_your_token" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "provider": "aws",
6    "instance_type": "t3.medium",
7    "region": "us-east-1",
8    "tags": { "env": "production", "team": "platform" }
9  }'

POST /api/v2/tenant/provision/vm → 201

X-API-Key · JSON

Terraform state is managed for you — no local install.
SSH key pairs are generated and stored in Vault automatically.
Works across AWS EC2, GCP Compute Engine, and Azure VMs.

Deploy a container or application

Deploy Docker containers, FastAPI apps, React frontends or Kubernetes workloads to that VM with one call. SSH, image pull and process management are handled automatically.

1curl -X POST https://api.vxcloud.io/api/v2/tenant/container/deploy \
2  -H "X-API-Key: vtx_live_your_token" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "image": "nginx:latest",
6    "vm_ip": "54.201.10.5",
7    "port": 80,
8    "env": { "NODE_ENV": "production" }
9  }'

POST /api/v2/tenant/container/deploy

X-API-Key · JSON

Pull from any registry — Docker Hub, ECR, GCR, ACR.
Environment variables, volume mounts and port mapping supported.
Stream live logs over /api/v2/tenant/docker/container/ws.

Monitor & observe

Query resource status, check VM health, stream container logs and track multi-cloud spend in real time through the built-in observability endpoints.

1# Cost breakdown across every connected cloud
2curl -X POST https://api.vxcloud.io/api/v2/tenant/billing/multicloud \
3  -H "X-API-Key: vtx_live_your_token" \
4  -d '{ "start_date": "2026-05-01", "end_date": "2026-05-31" }'
5 
6# AI cost-optimization recommendations
7curl -X POST https://api.vxcloud.io/api/v2/tenant/billing/optimization \
8  -H "X-API-Key: vtx_live_your_token" \
9  -d '{ "provider": "aws" }'

POST /api/v2/tenant/billing/multicloud

X-API-Key · JSON

Billing pulls from AWS Cost Explorer, GCP Billing, Azure Cost Management.
Optimization uses AI to flag idle / over-provisioned resources.
Observability routes live under /api/v2/tenant/observability/*.

Automate with workflows & CI/CD

Trigger GitHub Actions, GitLab CI or Temporal workflows programmatically. Chain provision → deploy → test → notify into one durable, retryable pipeline.

1curl -X POST https://api.vxcloud.io/api/v2/tenant/provision/githubactions \
2  -H "X-API-Key: vtx_live_your_token" \
3  -d '{
4    "repo": "my-org/my-repo",
5    "workflow": "deploy.yml",
6    "ref": "main",
7    "inputs": { "env": "production" }
8  }'