VPS.org API

REST API دستاویزات

بیک اپ API

پروگرام کے مطابق سرور کے بیک اپ کا نظم کریں۔ اپنے سرورز کے لیے بیک اپ کی فہرست بنائیں، بنائیں، بحال کریں اور حذف کریں۔

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

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

اپنے سرورز پر تمام بیک اپس کی فہرست بازیافت کریں۔

سوال کے پیرامیٹرز

پیرامیٹر قسم درکار ہے۔ تفصیل
server_id integer نہیں سرور ID کے ذریعہ بیک اپ کو فلٹر کریں۔
backup_type string نہیں قسم کے لحاظ سے فلٹر کریں: manual ، automatic

مثال کی درخواست

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/backups/"
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/backups/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const backups = await response.json();
console.log(backups);

مثال کا جواب

{
  "count": 3,
  "results": [
    {
      "id": 501,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4523,
      "created_at": "2025-01-16T03:00:00Z",
      "expires_at": "2025-02-16T03:00:00Z",
      "description": "Automatic daily backup"
    },
    {
      "id": 499,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "manual",
      "status": "completed",
      "size_mb": 4456,
      "created_at": "2025-01-14T10:30:00Z",
      "expires_at": null,
      "description": "Pre-update backup"
    },
    {
      "id": 495,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4389,
      "created_at": "2025-01-15T03:00:00Z",
      "expires_at": "2025-02-15T03:00:00Z",
      "description": "Automatic daily backup"
    }
  ]
}

رسپانس اسٹیٹس کوڈز

200 بیک اپ لسٹ کامیابی کے ساتھ بازیافت ہوئی۔
401 غیر مجاز - غلط یا گم شدہ تصدیقی ٹوکن
پوسٹ /api/v1/backups/

دستی بیک اپ بنائیں

سرور کا دستی بیک اپ بنائیں۔ دستی بیک اپ خود بخود ختم نہیں ہوتے ہیں۔

جسمانی پیرامیٹرز کی درخواست کریں۔

پیرامیٹر قسم درکار ہے۔ تفصیل
server_id integer جی ہاں بیک اپ کے لیے سرور کی ID
description string نہیں بیک اپ کے لیے اختیاری تفصیل

مثال کی درخواست

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "description": "Pre-deployment backup"
  }'
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "description": "Pre-deployment backup"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    description: 'Pre-deployment backup'
  })
});

const backup = await response.json();
console.log(backup);
$data = [
    'server_id' => 12345,
    'description' => 'Pre-deployment backup'
];

$ch = curl_init('https://admin.vps.org/api/v1/backups/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$backup = json_decode($response, true);
curl_close($ch);

مثال کا جواب

{
  "id": 502,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "backup_type": "manual",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T15:45:00Z",
  "expires_at": null,
  "description": "Pre-deployment backup",
  "message": "Backup is being created. This may take several minutes depending on server size."
}

رسپانس اسٹیٹس کوڈز

201 بیک اپ تخلیق کامیابی سے شروع ہو گئی۔
400 غلط درخواست - غلط پیرامیٹرز یا غلط درخواست
401 غیر مجاز - غلط یا گم شدہ تصدیقی ٹوکن
404 نہیں ملا - سرور موجود نہیں ہے۔
نوٹ: آپ فی سرور زیادہ سے زیادہ 10 دستی بیک اپ لے سکتے ہیں۔ آپ کے پلان کی بیک اپ برقرار رکھنے کی پالیسی (عام طور پر 7-30 دن) کی بنیاد پر خودکار بیک اپ برقرار رکھے جاتے ہیں۔
حذف کریں۔ /api/v1/backups/{backup_id}/

بیک اپ کو حذف کریں۔

بیک اپ کو مستقل طور پر حذف کریں۔ اس کارروائی کو کالعدم نہیں کیا جا سکتا۔

راستے کے پیرامیٹرز

پیرامیٹر قسم درکار ہے۔ تفصیل
backup_id integer جی ہاں منفرد بیک اپ ID

مثال کی درخواست

cURL
Python
JavaScript
curl -X DELETE "https://admin.vps.org/api/v1/backups/501/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

backup_id = 501
url = f"https://admin.vps.org/api/v1/backups/{backup_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
const backupId = 501;
const response = await fetch(`https://admin.vps.org/api/v1/backups/${backupId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

رسپانس اسٹیٹس کوڈز

204 بیک اپ کامیابی سے حذف ہو گیا۔
401 غیر مجاز - غلط یا گم شدہ تصدیقی ٹوکن
404 نہیں ملا - بیک اپ موجود نہیں ہے۔
انتباہ: بیک اپ کو حذف کرنا مستقل ہے اور اسے کالعدم نہیں کیا جا سکتا۔ اسے حذف کرنے سے پہلے یقینی بنائیں کہ آپ کو اس بیک اپ کی مزید ضرورت نہیں ہے۔

بیک اپس سے بحال ہو رہا ہے۔

بیک اپ سے سرور کو بحال کرنے کے لیے، سرورز API ریسٹور اینڈ پوائنٹ کا استعمال کریں:

POST /api/v1/servers/{server_id}/restore/
{
  "backup_id": 501
}

سرور کی بحالی کے بارے میں تفصیلی معلومات کے لیے، دیکھیں سرورز API دستاویزات.

بیک اپ بہترین پریکٹسز