VPS.org API

Pepa Fa'amaumauga o le REST API

API Ata Pupuu

Pulea ata pu'e o le 'au'aunaga mo se toe fa'aleleia vave i le taimi atofaina. O ata pu'e e pu'eina ai le tulaga atoa o lau 'au'aunaga.

Fa'ai'uga 4 endpoints
Ala Autu /api/v1/snapshots
MAUA /api/v1/snapshots/

Lisi Ata Uma

Toe aumai se lisi o ata uma i au 'au'aunaga.

Fa'asologa o Fesili

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
server_id integer Leai Fa'amama ata pu'e e ala i le ID o le 'au'aunaga

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/snapshots/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
params = {"server_id": 12345}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/snapshots/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const snapshots = await response.json();
console.log(snapshots);

Tali Fa'ata'ita'i

{
  "count": 2,
  "results": [
    {
      "id": 801,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "name": "pre-migration-snapshot",
      "status": "completed",
      "size_mb": 5120,
      "created_at": "2025-01-15T18:30:00Z",
      "description": "Before major migration"
    },
    {
      "id": 798,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "name": "weekly-snapshot-2025-01-08",
      "status": "completed",
      "size_mb": 4856,
      "created_at": "2025-01-08T12:00:00Z",
      "description": "Weekly snapshot"
    }
  ]
}

Fa'ailoga o Tulaga o Tali

200 Ua manuia le toe maua mai o le lisi o ata pu'e (snapshot list)
401 E le'i Fa'atagaina - Fa'ailoga fa'amaonia e le aoga pe ua misi
FA'AMATALAGA /api/v1/snapshots/

Fausia se Ata Pupuu

Create a snapshot of a server's current state. Snapshots are point-in-time copies of the entire server.

Talosaga mo Fa'atulagaga o le Tino

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
server_id integer Ioe ID o le 'au'aunaga i le snapshot
name string Ioe Igoa mo le ata pu'e (alphanumeric, hyphens, underscore)
description string Leai Fa'amatalaga fa'aopoopo mo le ata pu'e

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "name": "before-update-snapshot",
    "description": "Snapshot before system update"
  }'
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "name": "before-update-snapshot",
    "description": "Snapshot before system update"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    name: 'before-update-snapshot',
    description: 'Snapshot before system update'
  })
});

const snapshot = await response.json();
console.log(snapshot);

Tali Fa'ata'ita'i

{
  "id": 802,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "name": "before-update-snapshot",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T16:15:00Z",
  "description": "Snapshot before system update",
  "message": "Snapshot is being created. This may take 3-10 minutes depending on server size."
}

Fa'ailoga o Tulaga o Tali

201 Ua amata manuia le fatuina o se ata pu'e
400 Bad Request - Invalid parameters or snapshot limit reached
401 E le'i Fa'atagaina - Fa'ailoga fa'amaonia e le aoga pe ua misi
404 Not Found - Server does not exist
Fa'amatalaga: You can have a maximum of 5 snapshots per server. Creating a snapshot while the server is running may result in filesystem inconsistencies. For best results, stop the server before creating a snapshot.
FA'AMATALAGA /api/v1/snapshots/{snapshot_id}/restore/

Toe fa'afo'isia mai le Ata Pupuu

Restore a server to the state captured in a snapshot. This will overwrite all current data on the server.

Fa'asologa o Ala

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
snapshot_id integer Ioe ID tulaga ese o le ata pu'e

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/snapshots/801/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

snapshot_id = 801
url = f"https://admin.vps.org/api/v1/snapshots/{snapshot_id}/restore/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
print(response.json())
const snapshotId = 801;
const response = await fetch(`https://admin.vps.org/api/v1/snapshots/${snapshotId}/restore/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const result = await response.json();
console.log(result);

Tali Fa'ata'ita'i

{
  "status": "success",
  "message": "Server is being restored from snapshot. This may take 5-15 minutes.",
  "snapshot": {
    "id": 801,
    "name": "pre-migration-snapshot",
    "created_at": "2025-01-15T18:30:00Z"
  },
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "restoring"
  }
}

Fa'ailoga o Tulaga o Tali

200 Ua amata manuia le toe fa'aleleia
400 Bad Request - Server is not in a valid state for restoration
401 E le'i Fa'atagaina - Fa'ailoga fa'amaonia e le aoga pe ua misi
404 E le'i Maua - E leai se Ata Pupuu
Lapataiga: Restoring from a snapshot will overwrite all current data on the server. This action cannot be undone. The server will be automatically stopped before restoration begins.
TAPE'E /api/v1/snapshots/{snapshot_id}/

Tape le Ata Pupuu

Tape tumau se ata pu'e (snapshot). E le mafai ona toe fa'aleaogaina lenei gaioiga.

Fa'asologa o Ala

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
snapshot_id integer Ioe ID tulaga ese o le ata pu'e

Talosaga Fa'ata'ita'i

cURL
Python
curl -X DELETE "https://admin.vps.org/api/v1/snapshots/801/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

snapshot_id = 801
url = f"https://admin.vps.org/api/v1/snapshots/{snapshot_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)

Fa'ailoga o Tulaga o Tali

204 Ua manuia le tapeina o le ata pu'e
401 E le'i Fa'atagaina - Fa'ailoga fa'amaonia e le aoga pe ua misi
404 E le'i Maua - E leai se Ata Pupuu

Snapshots vs Backups

Understanding when to use snapshots versus backups:

API Ata Pupuu

  • Fa'amoemoega: Quick point-in-time recovery
  • Saosaoa: Faster to create and restore (3-15 min)
  • Fa'aoga: Before risky operations (updates, config changes)
  • Teuina: Stored on same infrastructure
  • Tapula'a: 5 snapshots per server
  • Sili mo: Short-term rollback capability

API Fa'asao

  • Fa'amoemoega: Long-term data protection
  • Saosaoa: Slower to create and restore (varies)
  • Fa'aoga: Regular automated data protection
  • Teuina: Separate backup storage
  • Tapula'a: 10 manual + automatic backups
  • Sili mo: Disaster recovery and compliance

Best Practices