VPS.org API

REST API Xuquuqda

Kaydinta API

Liiska aad server backups, bilowdo backup cusub iyo soo celinta server ka mid ah mid.

Dhammaadka 4
Waddo Saldhig ah /api/v1/backups
HEL /api/v1/backups/

Liis garee Dhammaan Kaydka

Ku soo laabtay backups servers aad oo dhan, ugu dambeeyay hore, 25 bogga. Ma jiro server filter: isticmaal server_hostname si ay u ururiyaan.

Xuquuqda loo baahan yahay: backups:list

Cabbirrada Weydiinta

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
page integer Ha Tirada bog, ka bilow 1

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Goobaha Jawaabta

Isku-darka Nooca Tilmaamaha
id integer Backup aqoonyahanka, loo isticmaalo by helitaanka iyo soo celinta endpoints
server_hostname string Magaca martida ee serverka xogta la soo celiyay laga qaaday
name string Magaca faylka kaydka ah
size_gb number Miisaanka la isku dhejiyay oo lagu sheegay gigabytes
deletion_date datetime Marka ay backup la saari doonaa si otomaatig ah
days_remaining integer Maalmood oo dhan oo ka hadhay ilaa deletion_date
created_at datetime Waqtiga abuurista (ISO 8601, UTC)

Koodhadhka Xaaladda Jawaab celinta

200 Ku guuleystay soo celinta liiska kaydinta
403 Xiran ama aan sharci ahayn API token, ama token ka maqan oggolaanshaha loo baahan yahay
HEL /api/v1/backups/{id}/

Ka hel a backup

Ku soo laabta mid ka mid ah wax ka mid ah kaydinta la goobaha kor ku xusan.

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

Abuur Koodhka Taageerada

Xidhiidhka a backup server la soo saaray. Ma jiro codsiga jirka waa in la baahan yahay. The backup ka muuqataa liiska marka ay dhamaatay, taas oo ay qaadan kartaa daqiiqado badan iyadoo ku xiran isticmaalka disk.

Xuquuqda loo baahan yahay: 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())

Jawaabta Tusaale

{
  "message": "Backup queued successfully"
}

Koodhadhka Xaaladda Jawaab celinta

200 Falku waa la isku raacay
400 Server-ka ma la soo bandhigin weli
402 Ma jiro habka lacag bixinta ee faylka, ama xisaabaadka aan la bixin
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale
BOOQO /api/v1/backups/{id}/restore/

Soo Celinta Server ka kaarka xusuusta

Jooji server ka dib markii la qaaday ka, ku qoro diskka la kaarka xusuusta iyo dib u bilaabayaa. Ma jiro codsiga jirka waa in la baahan yahay. Server xaaladda waa in la raaco inta dib u soo celinta socda.

Xuquuqda loo baahan yahay: 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"
}
Digniin: Wax kasta oo ku qoran server ka dib markii la backup waxaa la qaaday waa la waayey. A soo celinta ma aha in la joojiyo.

Koodhadhka Xaaladda Jawaab celinta

200 Falku waa la isku raacay
400 Server-ka ma la soo bandhigin weli
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale

Xigasho