VPS.org API

REST API Documentation

API مکان‌ها

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

نقاط پایانی 2 endpoints
مسیر پایه /api/v1/locations
دریافت کنید /api/v1/locations/

فهرست همه مکان‌ها

یک لیست از تمام مکان‌های موجود در مرکز داده که می‌توانید سرورهای VPS را در آنجا نصب کنید را بازیابی کنید.

درخواست نمونه

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

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

const locations = await response.json();
console.log(locations);
$ch = curl_init('https://admin.vps.org/api/v1/locations/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

پاسخ نمونه

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "New Jersey",
      "country_name": "United States",
      "country_code": "US",
      "is_active": true
    }
  ]
}

فیلدهای پاسخ

میدان نوع Description
id integer شناسه‌ی مکان. هنگام ایجاد کارگزار، به عنوان location_id از آن استفاده کنید.
name string نام مکان قابل خواندن انسان
country_name string کشوری که مکان در آن است
country_code string کد کشور ISO 3166-1 alpha-2, بزرگ‌خط
is_active boolean اینکه آیا محل کارسازهای جدید را می‌پذیرد یا خیر

کدهای وضعیت پاسخ

200 لیست مکان‌های بازیابی شده با موفقیت
403 نشان API مفقود یا نامعتبر، یا نشان اجازه مورد نیاز را ندارد
دریافت کنید /api/v1/locations/{id}/

گرفتن مکان

یک مکان واحد را با شناسه آن بازیابی کنید. پاسخ یک شیء مکان با زمینه‌های بالا است.

curl -X GET "https://admin.vps.org/api/v1/locations/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 1,
  "name": "New Jersey",
  "country_name": "United States",
  "country_code": "US",
  "is_active": true
}

جایی که کارگزارهای شما اجرا می‌شوند

هر سرور VPS.org در حال حاضر در محل ما در نیوجرسی، ایالات متحده آمریکا اجرا می‌شود، که به مشتریان در سراسر جهان از طریق IPv4 و IPv6 خدمت می‌کند. همیشه نقطه پایانی مکان‌ها را به جای کدگذاری سخت یک شناسه بخوانید، بنابراین ادغام شما هنگام اضافه شدن مکان‌های جدید را برمی‌دارد.