VPS.org API

REST API Documentation

Iifoto ze-Snapshots API

Lawula ii-snapshots zeseva ukuze ubuyisele ngokukhawuleza ngexesha elifanelekileyo. Ii-snapshots zibamba imeko epheleleyo yeseva yakho.

Iindawo zokugqibela 4 endpoints
Indlela Esisiseko /api/v1/snapshots
FUMANA /api/v1/snapshots/

Dwelisa Zonke Iifoto Ezifutshane

Fumana uluhlu lwazo zonke iifoto ezimfutshane kwiiseva zakho.

IiParamitha zoMbuzo

Parameter Uhlobo Kufuneka Description
server_id integer No Hluza izifinyezo nge-ID yeseva

Isicelo somzekelo

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);

Impendulo yoMzekelo

{
  "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"
    }
  ]
}

Iikhowudi zeMeko yokuphendula

200 Uluhlu lwesnapshot lufunyenwe ngempumelelo
401 Ayigunyaziswanga - Ithokheni yokuqinisekisa engasebenziyo okanye engekhoyo
POST /api/v1/snapshots/

Yenza i-Snapshot

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

Cela iiParamitha zoMzimba

Parameter Uhlobo Kufuneka Description
server_id integer Ewe Isazisi seseva ukuze sithathwe umfanekiso
name string Ewe Igama le-snapshot (i-alphanumeric, i-hyphens, i-underscores)
description string No Inkcazo yokuzikhethela yesnapshot

Isicelo somzekelo

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);

Impendulo yoMzekelo

{
  "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."
}

Iikhowudi zeMeko yokuphendula

201 Ukudalwa kwemifanekiso eqingqiweyo kuqaliswe ngempumelelo
400 Bad Request - Invalid parameters or snapshot limit reached
401 Ayigunyaziswanga - Ithokheni yokuqinisekisa engasebenziyo okanye engekhoyo
404 Not Found - Server does not exist
Note: 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.
POST /api/v1/snapshots/{snapshot_id}/restore/

Buyisela kwi-Snapshot

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

Iiparameter zeNdlela

Parameter Uhlobo Kufuneka Description
snapshot_id integer Ewe I-ID yesnapshot eyahlukileyo

Isicelo somzekelo

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);

Impendulo yoMzekelo

{
  "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"
  }
}

Iikhowudi zeMeko yokuphendula

200 Ukubuyisela kuqaliswe ngempumelelo
400 Bad Request - Server is not in a valid state for restoration
401 Ayigunyaziswanga - Ithokheni yokuqinisekisa engasebenziyo okanye engekhoyo
404 Ayifumaneki - Umfanekiso omfutshane awukho
Isilumkiso: 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.
CIMA /api/v1/snapshots/{snapshot_id}/

Cima iSnapshot

Cima umfanekiso omfutshane ngokusisigxina. Esi senzo asinakurhoxiswa.

Iiparameter zeNdlela

Parameter Uhlobo Kufuneka Description
snapshot_id integer Ewe I-ID yesnapshot eyahlukileyo

Isicelo somzekelo

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)

Iikhowudi zeMeko yokuphendula

204 Umfanekiso omfutshane ucinywe ngempumelelo
401 Ayigunyaziswanga - Ithokheni yokuqinisekisa engasebenziyo okanye engekhoyo
404 Ayifumaneki - Umfanekiso omfutshane awukho

Snapshots vs Backups

Understanding when to use snapshots versus backups:

Iifoto ze-Snapshots API

  • Injongo: Quick point-in-time recovery
  • Isantya: Faster to create and restore (3-15 min)
  • Ityala Lokusetyenziswa: Before risky operations (updates, config changes)
  • Indawo yokugcina: Stored on same infrastructure
  • Limit: 5 snapshots per server
  • Eyona ilungileyo: Short-term rollback capability

I-API yee-Backups

  • Injongo: Long-term data protection
  • Isantya: Slower to create and restore (varies)
  • Ityala Lokusetyenziswa: Regular automated data protection
  • Indawo yokugcina: Separate backup storage
  • Limit: 10 manual + automatic backups
  • Eyona ilungileyo: Disaster recovery and compliance

Best Practices