VPS.org API

REST API Documentation

API اسنپ‌شات‌ها

اکنون یک تابع را در یک جدول قرار دهید و آن را به تابعی که نیازی به آن ندارید، تبدیل کنید.

نقاط پایانی 4
مسیر پایه /api/v1/snapshots
دریافت کنید /api/v1/snapshots/

لیست کردن تمام اسنپ‌شات‌ها

عکسهای لحظه ای در حساب شما را با اول جدیدترین و ۲۵ در هر صفحه برمی‌گرداند.

مجوز مورد نیاز: 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
    }
  ]
}

فیلدهای پاسخ

میدان نوع Description
uuid string شناسۀ عکس) ۳۲ کاراکتر هشتم، بدون خط‌کش (
label string برچسبی که هنگام ایجاد عکس گرفته شده است
server_hostname string نام میزبان کارساز که از آن عکس گرفته شده است، یا اگر کارساز دیگر وجود نداشته باشد، صفر
ready boolean درست هنگامی که عکس برداری به پایان رسید
deleting boolean درست در حالی که حذف در حال انجام است
created_at datetime زمان ایجاد) ISO 8601 ، UTC (
size_gb number اندازه فشرده به گیگابایت
دریافت کنید /api/v1/snapshots/{uuid}/

گرفتن یک عکس

یک شیء عکس‌العمل با حوزۀ بالا را برمی‌گرداند. از آن برای پرس و جو آماده پس از ایجاد یک عکس‌العمل استفاده کنید.

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

ایجاد یک عکس

یک عکس فوری از یک کارگزار پراکنده شده را در صف قرار می‌دهد و uuid عکس فوری جدید را برمی‌گرداند. عکس فوری با تنظیم آماده به false بلافاصله فهرست می‌شود.

مجوز مورد نیاز: servers:snapshot

درخواست پارامترهای بدنه

Parameter نوع مورد نیاز Description
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 action یا snapshot_label گم شده است، یا کارگزار هنوز پراکنده نشده است
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 پیدا نشد یا متعلق به حساب دیگری است

یادداشتها