VPS.org API

REST API ஆவணமாக்கல்

காப்புப்பிரதிகள் API

உங்கள் சேவையக காப்புப் படங்களை பட்டியலிடு, புதிய காப்புப் படத்தை துவக்கு மற்றும் சேவையகத்தை ஒன்றிலிருந்து மீட்டெடு.

முனைப்புள்ளிகள் 4
அடிப்படை பாதை /api/v1/backups
பெறு /api/v1/backups/

அனைத்து காப்புப்பிரதிகளையும் பட்டியலிடுங்கள்

உங்கள் அனைத்து சேவையகங்களின் காப்புப் பிரதிகளை திரும்பத் தரும், புதியது முதலில், பக்கத்திற்கு 25. சேவையக வடிகட்டி இல்லை: server_ hostname ஐ குழுவாக்க பயன்படுத்தவும்.

அனுமதி தேவை: backups:list

வினவல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
page integer இல்லை பக்க எண், 1ல் தொடங்குகிறது

மாதிரி கோரிக்கை

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

எடுத்துக்காட்டு பதில்

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

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
id integer காப்பு அடையாளம், பெறுதல் மற்றும் மீட்டெடுப்பு முடிவு புள்ளிகளால் பயன்படுத்தப்பட்டது
server_hostname string காப்பு எடுக்கப்பட்ட சேவையகத்தின் புரவலன் பெயர்
name string காப்புக்காப்பு ஆவணக் கோப்புப் பெயர்
size_gb number கிகாபைட்டுகளில் அழுத்தப்பட்ட அளவு
deletion_date datetime காப்புக்கோப்பு தானாக நீக்கப்படும் போது
days_remaining integer நீக்குதல்_ தேதிக்கு முழு நாட்கள் மீதி
created_at datetime உருவாக்கும் நேரம் (ISO 8601, UTC)

பதில் நிலை குறியீடுகள்

200 காப்புப் பட்டியல் வெற்றிகரமாக மீட்டெடுக்கப்பட்டது
403 காணாமல் போன அல்லது செல்லாத API டாக், அல்லது டாக் தேவையான அனுமதியைக் கொண்டிருக்கவில்லை
பெறு /api/v1/backups/{id}/

காப்புக்கோப்பினை பெறு

மேலே உள்ள புலங்களுடன் ஒரு காப்புப் பொருளை திரும்பக் கொடுக்கிறது.

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

காப்புக்கோப்பினை உருவாக்கு

சேவையகத்தின் காப்புப் படத்தை வரிசைப்படுத்துகிறது. கோரிக்கை உடல் தேவையில்லை. முடிந்தவுடன் காப்புப் படம் பட்டியலில் தோன்றும், இது வட்டு பயன்பாட்டை பொறுத்து சில நிமிடங்கள் எடுக்கலாம்.

அனுமதி தேவை: 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())

எடுத்துக்காட்டு பதில்

{
  "message": "Backup queued successfully"
}

பதில் நிலை குறியீடுகள்

200 செயல் வரிசைப்படுத்தப்பட்டது
400 சேவையகம் இன்னும் செயல்படுத்தப்படவில்லை
402 கோப்பில் செலுத்தும் முறை இல்லை, அல்லது செலுத்தாத விலைப்பத்திரங்கள்
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
அஞ்சல் /api/v1/backups/{id}/restore/

காப்புக்கோப்பிலிருந்து சேவையகத்தை மீட்டெடு

காப்பு எடுக்கப்பட்ட சேவையகத்தை நிறுத்துகிறது, காப்பு எடுக்கப்பட்ட வட்டுடன் அதன் மேல் எழுதுகிறது மற்றும் மீண்டும் துவக்குகிறது. கோரிக்கை உடல் தேவையில்லை. சேவையக நிலை திரும்பி இயங்கும் போது வரிசை.

அனுமதி தேவை: 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"
}
எச்சரிக்கை: காப்பு எடுக்கப்பட்ட பிறகு சேவையகத்திற்கு எழுதப்பட்ட அனைத்தும் இழக்கப்படும். மீட்டமைப்பு செயல் திரும்ப செய்யப்படாது.

பதில் நிலை குறியீடுகள்

200 செயல் வரிசைப்படுத்தப்பட்டது
400 சேவையகம் இன்னும் செயல்படுத்தப்படவில்லை
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது

குறிப்புகள்