Prerequisites
- A Raff Cloud Platform account (sign up)
- An API key (generate one from your dashboard)
Step 1: Check API Health
Verify the API is reachable (no authentication required):
curl https://api.rafftechnologies.com/health
Step 2: List Your VMs
Use your API key to list virtual machines on your account:
curl -H "X-API-Key: YOUR_API_KEY" \
https://api.rafftechnologies.com/api/v1/vms
{
"data": [],
"total": 0
}
Step 3: Create a VM
Create your first virtual machine. Write operations require the X-Project-ID header — you can find your project ID in the Raff Dashboard under your project settings.
curl -X POST https://api.rafftechnologies.com/api/v1/vms \
-H "X-API-Key: YOUR_API_KEY" \
-H "X-Project-ID: YOUR_PROJECT_ID" \
-H "Content-Type: application/json" \
-d '{
"name": "my-first-vm",
"template_id": "<template-uuid>",
"pricing_id": 1,
"region": "us-east"
}'
Replace <template-uuid> with an actual OS template ID. You can find available templates in your dashboard.
Step 4: Check VM Status
Once created, fetch your VM details:
curl -H "X-API-Key: YOUR_API_KEY" \
https://api.rafftechnologies.com/api/v1/vms/{vm-id}
provisioning → booting → initiating → active.
Step 5: Control Your VM
Start, stop, or reboot your VM:
# Stop a VM
curl -X POST -H "X-API-Key: YOUR_API_KEY" -H "X-Project-ID: YOUR_PROJECT_ID" \
https://api.rafftechnologies.com/api/v1/vms/{vm-id}/stop
# Start a VM
curl -X POST -H "X-API-Key: YOUR_API_KEY" -H "X-Project-ID: YOUR_PROJECT_ID" \
https://api.rafftechnologies.com/api/v1/vms/{vm-id}/start
# Reboot a VM
curl -X POST -H "X-API-Key: YOUR_API_KEY" -H "X-Project-ID: YOUR_PROJECT_ID" \
https://api.rafftechnologies.com/api/v1/vms/{vm-id}/reboot
Next Steps
