VPS.org API

Litokomane tsa REST API

API ea Li-backup

Litšoantšo tsa backup tsa server, qala backup e ncha le ho khutlisa server ho tloha ho e 'ngoe.

Mafelo a ho Qetela 4
Tsela ea Motheo /api/v1/backups
FUMANA /api/v1/backups/

Thathamisa Li-backup Tsohle

E khutlisa li-backup tsa liserver tsohle tsa hau, tse ncha ka ho fetisisa pele, 25 ka leqephe. Ha ho na sehuoa sa server: sebelisa server_hostname ho li kopanya.

Litokelo li hlokahale: backups:list

Liparamitha tsa Potso

Parameter Mofuta E hlokahala Bophara
page integer Ha ho joalo Page number, starting at 1

Kopo ea Mohlala

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Karabo ea Mohlala

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

Masimo a Karabo

Setereke Mofuta Bophara
id integer Mokhatlo oa ho boloka, o sebelisoang ke ho fumana le ho khutlisa li-endpoints
server_hostname string Lebitso la mofani oa sebaka sa marang-rang seo backup e nkang ho sona
name string Lebitso la faele ea ho boloka
size_gb number Boholo ba ho kopanngoa ka gigabytes
deletion_date datetime Ha backup e tlosoa ka ho toba
days_remaining integer Libeke tse 12 tse ka morao ho deletion_date
created_at datetime Nako ea ho theha (ISO 8601, UTC)

Likhoutu tsa Boemo ba Karabelo

200 Li-backup li fumaneha ka katleho
403 Token ea API e sa nepahalang kapa e sa fumaneheng, kapa token e na le litokelo tse hlokahalang
FUMANA /api/v1/backups/{id}/

Fumana backup

E khutlisa ntho e le 'ngoe ea backup e nang le libaka tse ka holimo.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/backup/

E_ra

E tlisa kapele ho boloka ho tsoa ho seva e kentsoeng. Ha ho hlokahale hore ho be le'mele oa kopo. Ho boloka ho hlaha ho lenane ha ho etsoa, ho ka nka metsotsoana e meng e'maloa ho latela ho sebelisoa ha disk.

Litokelo li hlokahale: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

Karabo ea Mohlala

{
  "message": "Backup queued successfully"
}

Likhoutu tsa Boemo ba Karabelo

200 Ts'ebetso e ne e le ka lebokoseng
400 Motsamaisi oa setsi ha a na ho kenya
402 Ha ho na mokhoa oa ho lefa ka faele, kapa li-invoice tse sa lefisoeng
404 Ha e fumanehe, kapa e na le akhaonto e 'ngoe
POST /api/v1/backups/{id}/restore/

Ho khutlisa server ho tloha ho backup

E qeta setsi seo backup e neng e etsoa ho sona, e ngola ka ho feletseng disk ea eona ka backup ebe e qala ho e etsa hape. Ha ho hlokahale hore ho be le motho ea hlokang ho e etsa. Mofuta oa setsi ke oa ho roala kapele ha ho khutlisoa ho ntse ho etsoa.

Litokelo li hlokahale: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
Bopaki: Lintlha tsohle tse ngotsoeng ho seva ka mor'a hore backup e be e nkoa li lahleheloa ke. Ho khutlisa ha ho ka fetoloa.

Likhoutu tsa Boemo ba Karabelo

200 Ts'ebetso e ne e le ka lebokoseng
400 Motsamaisi oa setsi ha a na ho kenya
404 Ha e fumanehe, kapa e na le akhaonto e 'ngoe

Litlhaku