VPS.org API Documentation

شروع به کار

رابط برنامه‌نویسی کاربردی VPS.org به شما امکان می‌دهد تا تمام جنبه‌های زیرساخت میزبانی VPS خود، از جمله سرورها، دامنه‌ها، رکوردهای DNS، پشتیبان‌گیری‌ها و اسنپ‌شات‌ها را به صورت برنامه‌نویسی مدیریت کنید.

احراز هویت

همه درخواست‌های API نیاز به احراز هویت با استفاده از توکن Bearer دارند. می‌توانید توکن API خود را از تنظیمات حساب کاربری خود در آدرس زیر ایجاد کنید. admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

هر توکن اجازه‌های خود را حمل می‌کند، مانند servers:list یا dns:*. یک درخواست که نیاز به اجازه دارد و توکن آن را ندارد با 403 و یک field required_permission که اجازه گم شده را نام می‌برد رد می‌شود. مرجع مجوزها

محدود کردن نرخ

درخواستهای احراز هویت به ۱۰۰۰ در ساعت برای هر حساب محدود می‌شوند. درخواستهای احراز هویت نشده به ۱۰۰ در ساعت برای هر نشانی IP محدود می‌شوند. یک درخواست بیش از حد ، ۴۲۹ را با سرآیند Retry-After دریافت می‌کند که تعداد ثانیه‌های منتظر ماندن را می‌دهد. سرآیندهای محدودیت نرخ برای پاسخهای موفق ارسال نمی‌شوند.

صفحه‌بندی

فهرست نقاط پایانی یک شیء با شمارش، بعدی، قبلی و نتایج، ۲۵ مورد در هر صفحه را برمی‌گرداند. برای حرکت بین صفحات صفحه‌ای را عبور دهید، یا نشانی اینترنتی بعدی را دنبال کنید تا اینکه صفر شود. فهرست کارسازها همچنین اندازه_صفحه را تا ۱۰۰ قبول می‌کند.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

مدیریت خطا

این API از کدهای وضعیت استاندارد HTTP برای نشان دادن موفقیت یا شکست استفاده می‌کند:

بدنهٔ خطا JSON است. بیشتر آن‌ها یک میدان جزئیات یا یک میدان خطا دارند، گاهی اوقات با یک پیام؛ خطاهای اعتبارسنجی مشکلات را با نام میدان فهرست می‌کنند.

دسته بندی های API

مستندات API ما را بر اساس دسته‌بندی مرور کنید:

نقطه پایانی بیشتر

API همچنین دارای نقطه پایانی برای پیاده‌سازی برنامه (/api/v1/deploy-configs/ و /api/v1/deployments/) است. آن‌ها هنوز در این صفحات توصیف نشده‌است؛ مرجع تعاملی هر نقطه پایانی را که از API زنده تولید شده‌است، فهرست می‌کند.

به کمک نیاز دارید؟

اگر سوالی دارید یا در مورد API به کمک نیاز دارید، لطفاً دریغ نکنید با ما تماس بگیرید:

• تیکت‌های پشتیبانی: یک تیکت پشتیبانی باز کنید
• ایمیل: hello@vps.org
• Documentation: مستندات کامل