VPSie home
Company

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.

POST /serversPOST /servers

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-auth header
  • Call GET /datacenter to prove name, route and token work
  • Read the reference for every endpoint, field and example

API reference Try it live

curl -H "vpsie-auth: $VPSIE_TOKEN" \ https://api.vpsie.com/apps/v2/datacenter

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.

Customers

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
Resellers and partners

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
iOS and Android

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
Infrastructure as code

Terraform guide

The VPSie provider for Terraform and OpenTofu manages servers, networks, storage and Kubernetes as code.

  • Provider vpsie/vpsie
  • Import existing resources
CLI

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
SDK

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.

Go SDK

github.com/vpsie/govpsie, documented on pkg.go.dev.

Private cloud

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

ToolBest forNot for
REST APIAny language, ERP and CRM links, one-off jobsKeeping a whole environment in step with code
TerraformRepeatable environments you review before applyingQuick one-time changes
Command lineShell scripts, CI jobs, quick actionsLong-lived services (use the SDK)
Go SDKServices you build and ship in GoOther languages (use the REST API)
Mobile appChecking servers and billing on the moveBulk work

More help

Knowledge base

How-to articles, one-click app tutorials and answers to common questions.

FAQ

Short answers about plans, locations, billing and security.

Support

Stuck on a call or a resource? Open a ticket, 24/7/365.

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 onLook forRelated page
Servers and operating systemsCreating, resizing, rebuilding and accessing cloud servers; SSH and console accessCompute
Storage and filesAdding disks, mounting volumes, using object storage bucketsStorage, Buckets
Networking and DNSPrivate networks, firewalls, load balancing, IP addresses, DNS recordsNetworking, DNS
ContainersKubernetes clusters and workloadsKubernetes
Backup and recoverySnapshots, scheduled backups, restoring a serverBackup, Recovery
One-click appsInstalling and configuring ready-made applicationsApps
Security and accessTwo-factor sign-in, keys, user roles, hardening a serverSecurity
Moving inImporting machines from another platformMigration

Browse the knowledge base

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.

1Create an account2Learn the console3Automate one task4Protect it3142Automate one taskCreate an accountProtect itLearn the console
A path through the documentation that avoids dead ends.
GET /datacenterGET /datacenter

Build on VPSie

Create an account, issue a token and make your first call.