VPS.org API

REST API دستاویزی

سنیپ شاٹس API

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

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

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

آپ کے اکاؤنٹ میں سناپ شاٹ واپس کرتا ہے، تازہ ترین پہلے، 25 پر صفحہ.

اجازت لازم ہے: snapshots:list

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

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

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

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

مثال کا جواب

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

رسپانس فیلڈز

شعبہ قسم وضاحت
uuid string سناپ شاٹ شناخت (32 hexadecimal حروف، کوئی ہائبن نہیں)
label string لیبل دیا گیا جب سناپ شاٹ بنایا گیا تھا
server_hostname string سرور کا میزبان نام جس سے سناپ شاٹ لیا گیا تھا، یا اگر وہ سرور اب موجود نہیں ہے تو خالی
ready boolean سچ جب سناپ شاٹ ختم ہو جائے
deleting boolean صحیح جب حذف کرنے کا عمل جاری ہو
created_at datetime تخلیق کا وقت (ISO 8601، UTC)
size_gb number دباؤ میں حجم gigabytes میں
حاصل کریں۔ /api/v1/snapshots/{uuid}/

ایک سناپ شاٹ حاصل کریں

اوپر کے شعبوں کے ساتھ ایک سناپ شاٹ عائد کرتا ہے اس کو سناپ شاٹ بنانے کے بعد پو ل تیار کرنے کے لیے استعمال کریں

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
پوسٹ /api/v1/servers/{uuid}/snapshot/

ایک سناپ شاٹ بنائیں

ایک انکشاف سرور کی ایک سناپ شاٹ کی قطار لگاتا ہے اور نئے سناپ شاٹ کے uuid کو واپس کرتا ہے. سناپ شاٹ فوراً فہرست میں ہے تیار کو غلط مقرر کیا گیا ہے.

اجازت لازم ہے: servers:snapshot

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

پرائمری قسم درکار ہے۔ وضاحت
action string جی ہاں سناپ شاٹ ہونا چاہیے
snapshot_label string جی ہاں ایک لیبل جس سے سناپ شاٹ پہچانا جا سکے
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

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

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

مثال کا جواب

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

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

200 عمل کو قطار میں رکھا گیا تھا
400 عمل یا سناپشٹ لیبل غائب ہے، یا سرور اب تک متعارف نہیں کیا گیا ہے
402 فائلیں پر کوئی ادائیگی کا طریقہ نہیں ہے، یا غیر ادا کیے گئے بل
404 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا
حذف کریں۔ /api/v1/snapshots/{uuid}/

ایک سناپ شاٹ حذف کریں

سناپ شاٹ کو ہمیشہ کے لیے حذف کرنے کے لیے قطار میں رکھتا ہے حذف کرنا صحیح ہے جب تک یہ چلتا نہیں

اجازت لازم ہے: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

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

202 قبول: درخواست کو قطار میں رکھا گیا
404 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا

یادداشتیں