VPS.org API

REST API دستاویزی

بیک اپ API

آپ کے سرور کی بک اپ کی فہرست، ایک نئی بک اپ شروع کریں اور ایک سرور سے ایک سرور کو بحالی کریں.

اینڈ پوائنٹس 4
بنیاد کا راستہ /api/v1/backups
حاصل کریں۔ /api/v1/backups/

تمام بیک اپ کی فہرست بنائیں

آپ کے تمام سرور کے بک اپ واپس کرتا ہے، نئے سے پہلے، 25 پر صفحہ. کوئی سرور فلٹر نہیں ہے: ان کو گروپ کرنے کے لیے سرور_ ہوسٹ نام استعمال کریں.

اجازت لازم ہے: 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 دباؤ میں حجم gigabytes میں
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 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا

یادداشتیں