Skip to content

Getting started

The quicksrv API lets you create and manage VPS instances programmatically. It is a JSON REST API served at:

https://api.prod.quicksrv.io/api/v1
  1. Sign in to the quicksrv panel.
  2. Go to Account → API keys.
  3. Click Create key, give it a name (e.g. Terraform CI), and choose the scopes it needs.
  4. Copy the key — it is shown once and starts with qsk_live_.

See Authentication for details on scopes and key handling.

Every request authenticates with your key as a Bearer token. The /whoami endpoint is a quick way to confirm a key works:

Terminal window
curl https://api.prod.quicksrv.io/api/v1/whoami \
-H "Authorization: Bearer qsk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
{
"user_id": 42,
"email": "you@example.com",
"key_name": "Terraform CI",
"key_prefix": "qsk_live_a1b2c3",
"scopes": ["vps:read", "vps:write", "vps:create"]
}
Terminal window
curl https://api.prod.quicksrv.io/api/v1/instances \
-H "Authorization: Bearer qsk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

The API is versioned in the path (/api/v1). We will not make backwards-incompatible changes within a version. New fields may be added to responses, so write clients that ignore unknown fields.

  • All request and response bodies are JSON. Send Content-Type: application/json on requests with a body.
  • Timestamps are ISO 8601 UTC.
  • Monetary amounts are in EUR and charged against your wallet balance.
  • IDs in the path (e.g. /instances/{id}) are your quicksrv instance IDs, not provider-internal IDs.

Next: Authentication →