Documentation for the API, Terraform and CLI
The API reference, guides for Terraform, the command line, the Go SDK and the mobile app, and a short start for first-time API users.
Start with the API
The VPSie API is open to every customer. The reference is published and you can try calls live.
Getting started with the API
Five steps from nothing to a working call.
- Create an API client or access token in the console under API access
- Exchange the client ID and client secret for a short-lived token, or use a personal access token
- Send the token in the
vpsie-authheader - Call
GET /datacenterto prove name, route and token work - Read the reference for every endpoint, field and example
Base address https://api.vpsie.com/apps/v2. JSON in and out. On a private install, use your own API host; the path after the host is the same.
Guides for each audience and tool
One guide per audience and tool. Each says what it covers and who it is for.
User API guide
Authenticate, create and manage servers, protect them, read billing and handle errors, including how to connect ERP and CRM tools and private installs.
- Short and full versions
- Examples in curl
Reseller API guide
Onboard customers, assign plans and pricing, fund credit, read usage and pull billing data from your own portal.
- Short and full versions
- Scoped to your customers
Mobile app guide
Every menu of the VPSie Cloud app for iOS and Android, and what to expect when a feature is not enabled on your account.
- Sign in by email, QR with Client ID or biometrics
Terraform guide
The VPSie provider for Terraform and OpenTofu manages servers, networks, storage and Kubernetes as code.
- Provider vpsie/vpsie
- Import existing resources
Command line guide
vpsiecli manages servers, snapshots, firewalls and billing from your shell, for scripts and CI.
- 28 command groups, 204 commands
- Token from a YAML config
Go SDK guide
govpsie is the Go client for the API: servers, storage, networking, DNS, Kubernetes, billing and more as typed methods.
- MPL-2.0 license
- Go 1.24
Open-source tools
Terraform provider
Published on the Terraform Registry as vpsie/vpsie. Works with OpenTofu.
Admin API
The operator API for a VPSie platform you run yourself (clients, plans, infrastructure, billing, licensing, audit). It comes with a private cloud install.
- Ask your VPSie contact for the guide
Which tool for which job
| Tool | Best for | Not for |
|---|---|---|
| REST API | Any language, ERP and CRM links, one-off jobs | Keeping a whole environment in step with code |
| Terraform | Repeatable environments you review before applying | Quick one-time changes |
| Command line | Shell scripts, CI jobs, quick actions | Long-lived services (use the SDK) |
| Go SDK | Services you build and ship in Go | Other languages (use the REST API) |
| Mobile app | Checking servers and billing on the move | Bulk work |
More help
Knowledge base
How-to articles, one-click app tutorials and answers to common questions.
Questions about the VPSie documentation
Is the API available on every plan?
Roles, account status and your license apply to API calls exactly as they do in the console. A call to a service your license does not include is refused, even when the endpoint is documented.
Can I run a script against a private VPSie install?
Yes. Use your own API host name instead of api.vpsie.com. The path after the host is the same, and the caller must trust the certificate the install presents.
Will fields change?
Yes. The platform and its API change over time. Write code that ignores new fields, and check apidocs.vpsie.com before a release.
Where do I download the guides?
The guides are PDF and Word documents shared by VPSie. Ask your account manager or support for the current set.
Knowledge base by topic
Where to look in the knowledge base for each kind of question.
| If you are working on | Look for | Related page |
|---|---|---|
| Servers and operating systems | Creating, resizing, rebuilding and accessing cloud servers; SSH and console access | Compute |
| Storage and files | Adding disks, mounting volumes, using object storage buckets | Storage, Buckets |
| Networking and DNS | Private networks, firewalls, load balancing, IP addresses, DNS records | Networking, DNS |
| Containers | Kubernetes clusters and workloads | Kubernetes |
| Backup and recovery | Snapshots, scheduled backups, restoring a server | Backup, Recovery |
| One-click apps | Installing and configuring ready-made applications | Apps |
| Security and access | Two-factor sign-in, keys, user roles, hardening a server | Security |
| Moving in | Importing machines from another platform | Migration |
Reading order for new users
A path through the documentation that avoids dead ends.
Create an account
Sign up at my.vpsie.com, add a payment method and deploy a first server.
Learn the console
Use the knowledge base for the first server, storage and network tasks.
Automate one task
Make your first API call from the quick start above, then pick the CLI or Terraform for repeatable work.
Protect it
Set up backups and a restore test before the first real data arrives.
Build on VPSie
Create an account, issue a token and make your first call.