The Raff public API is currently in Beta (v1.0.0). The endpoint surface is stable; minor backward-compatible changes may land before GA. Track them in the API Changelog.
What is Raff?
Raff is a developer-friendly cloud for running virtual machines, block storage, object storage, managed Kubernetes, and VPC networking. This Reference tab is for driving Raff programmatically — REST API, CLI, or Terraform. For product guides and dashboard tutorials, see the Products tab.Pick your interface
REST API
Full HTTP API with an interactive playground. Auth via
X-API-Key.CLI
Single static
raff binary. Right for one-off ops, scripts, and CI/CD.Terraform
Declarative IaC. Right for production, code-review, multi-tenancy.
Base URL
Getting Started
Get an API key
Open the Raff Dashboard, click Team & Projects → API Keys, then Create API Key. Copy the secret immediately — it’s only shown once.
Pick your interface and authenticate
- API: set the
X-API-Keyheader on every request — see Authentication. - CLI: install with
go installor a release binary, then runraff configure. - Terraform: declare the provider and pass
api_key(or setRAFF_API_KEY).
Make your first call
- API: follow the Quickstart to list VMs and create one with
curl. - CLI:
raff vm listthenraff vm create --name … --template-id … --pricing-id … --region us-east. - Terraform: copy the Terraform quick start and run
terraform apply.