Sign up

Simple VPS API

Create and manage Simple VPS over HTTP with an API token. Every operation has its own page with its fields, examples, an example answer and the errors it gives.

OpenAPI file

Everything in this reference as one OpenAPI 3.1 file: operations, fields, examples and errors. Import it into Postman or Insomnia, generate a client from it, or give it to an LLM to write code against the API.

Download openapi.json

Base URL

https://platform.serverscamp.com/api/v1

Authentication

Make a token in the Cloud Panel under Settings, API tokens and send it with every request. A token acts for its account in full, so keep it as you would a password.

curl "https://platform.serverscamp.com/api/v1/vps" \
  -H "Authorization: Bearer $API_TOKEN"

Requests and answers

Bodies are JSON with Content-Type: application/json, and every answer is JSON. A VPS changes in the background: create, restore, reinstall and delete answer at once with the new status, and Get a VPS shows when the work is done.

Errors

An error has an HTTP status and a detail that says what went wrong in words you can show to a person. On a 422 it is a list instead, one entry for each field that is not right.

{"detail": "This plan is out of stock right now, try a smaller one"}
StatusMeaning
400A value that is not accepted; detail says which
401No token, or a token that is not valid
402The balance does not cover what was asked
403A limit of the account is reached; request more on the Limits page
404No such thing in your account
409Not possible right now: out of stock, or the server is busy
422The body is not what the operation takes
429Too many of these in a short time

Operations

Plans and images

Servers

Power

Backups

Reinstall and resize

Reverse DNS

Metrics

SSH keys