Authentication Guide

The TechVPS REST API endpoints use token-based authentication protocols via bearer keys. All external incoming programmatic request structures must pass your secure secret token inside an explicit custom HTTP header context wrapper.

Keep credentials isolated. Do not embed direct keys explicitly into localized codebases or exposed client repository versions.

Authorization: Bearer tvps_live_secret_key_prod_example

Retrieve All VPS Instances

Returns a paginated list payload containing configuration metrics, operational conditions, assigned network links, and internal properties for all cloud instances active under your authorization profile.

GET /v1/virtual-machines
Query Parameters
limitinteger
Number of items to return in the array payload. Range: 1 to 100. Default is 20.
statusstring
Filter instances by current operational state: running, stopped, or provisioning.
curl -X GET "https://api.techvps.website/v1/virtual-machines?limit=2" \
  -H "Authorization: Bearer tvps_live_secret_key"
Response Payload Example (200 OK)
{
  "object": "list",
  "data": [
    {
      "id": "vps_84f2910a",
      "name": "production-api-node",
      "cpu_cores": 4,
      "ram_mb": 8192,
      "status": "running",
      "ip_address": "194.156.45.12"
    }
  ],
  "has_more": false
}

Create Virtual Machine Instance

Provisions a brand new hypervisor cluster slice running isolated resources immediately based on parameter blueprints.

POST /v1/virtual-machines
Request Body Properties
plan_idstring Required
The specific hardware tier blueprint identifier (e.g., epyc-premium-v1).
image_idstring Required
Operating system snapshot identity tag reference. Example: ubuntu-24-04-lts.
regionstring Required
Target deployment datacenter region string link code identifier (e.g., sg-equinix-2).
curl -X POST "https://api.techvps.website/v1/virtual-machines" \
  -H "Authorization: Bearer tvps_live_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "epyc-premium-v1",
    "image_id": "ubuntu-24-04-lts",
    "region": "sg-equinix-2"
  }'