Servers API - VPS.org

دریافت کنید /api/v1/servers/

لیست همه سرورها

فهرستی از تمام سرورهای موجود در حساب کاربری خود را بازیابی کنید.

پارامترهای پرس و جو

پارامتر	نوع	مورد نیاز	توضیحات
`status`	رشته	خیر	فیلتر بر اساس وضعیت سرور: فعال، متوقف، معلق
`location`	رشته	خیر	فیلتر بر اساس موقعیت مکانی دیتاسنتر

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

cURL

Python

JavaScript

PHP

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 servers = await response.json();
console.log(servers);

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

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

پاسخ نمونه

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "web-server-01",
      "hostname": "web01.example.com",
      "status": "active",
      "ip_address": "203.0.113.10",
      "location": "us-west",
      "plan": {
        "id": 1,
        "name": "Standard VPS",
        "vcpus": 2,
        "memory": 4096,
        "storage": 80
      },
      "os": {
        "id": 5,
        "name": "Ubuntu 22.04 LTS"
      },
      "created_at": "2025-01-10T14:30:00Z",
      "updated_at": "2025-01-15T10:20:00Z"
    },
    {
      "id": 12346,
      "name": "db-server-01",
      "hostname": "db01.example.com",
      "status": "active",
      "ip_address": "203.0.113.11",
      "location": "us-east",
      "plan": {
        "id": 2,
        "name": "Performance VPS",
        "vcpus": 4,
        "memory": 8192,
        "storage": 160
      },
      "os": {
        "id": 3,
        "name": "Debian 12"
      },
      "created_at": "2025-01-12T09:15:00Z",
      "updated_at": "2025-01-16T08:45:00Z"
    }
  ]
}

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

200	لیست سرورها با موفقیت بازیابی شد
401	غیرمجاز - توکن API نامعتبر است یا وجود ندارد

پست /api/v1/servers/

ایجاد سرور جدید

یک سرور VPS جدید با پیکربندی مشخص راه‌اندازی کنید.

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

پارامتر	نوع	مورد نیاز	توضیحات
`name`	رشته	بله	نام سرور (اعداد و حروف، خط فاصله مجاز است)
`plan_id`	عدد صحیح	بله	شناسه طرح VPS
`os_id`	عدد صحیح	بله	شناسه سیستم عامل
`location`	رشته	بله	کد موقعیت مکانی دیتاسنتر
`hostname`	رشته	خیر	نام میزبان سرور (FQDN)
`ssh_key_id`	عدد صحیح	خیر	شناسه کلید SSH برای نصب
`backups_enabled`	بولی	خیر	فعال کردن پشتیبان‌گیری خودکار (پیش‌فرض: false)

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

cURL

Python

JavaScript

PHP

curl -X POST "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": true
  }'

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'web-server-02',
    plan_id: 1,
    os_id: 5,
    location: 'us-west',
    hostname: 'web02.example.com',
    backups_enabled: true
  })
});

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

$data = [
    'name' => 'web-server-02',
    'plan_id' => 1,
    'os_id' => 5,
    'location' => 'us-west',
    'hostname' => 'web02.example.com',
    'backups_enabled' => true
];

$ch = curl_init('https://admin.vps.org/api/v1/servers/');
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);
$server = json_decode($response, true);
curl_close($ch);

پاسخ نمونه

{
  "id": 12347,
  "name": "web-server-02",
  "hostname": "web02.example.com",
  "status": "provisioning",
  "ip_address": null,
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "created_at": "2025-01-16T15:30:00Z",
  "updated_at": "2025-01-16T15:30:00Z",
  "message": "Server is being provisioned. This may take 2-5 minutes."
}

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

201	سرور با موفقیت ایجاد شد
400	درخواست بد - پارامترهای نامعتبر
401	غیرمجاز - توکن API نامعتبر است یا وجود ندارد
402	پرداخت الزامی است - اعتبار کافی نیست

دریافت کنید /api/v1/servers/{server_id}/

دریافت جزئیات سرور

اطلاعات دقیق در مورد یک سرور خاص را بازیابی کنید.

پارامترهای مسیر

پارامتر	نوع	مورد نیاز	توضیحات
`server_id`	عدد صحیح	بله	شناسه منحصر به فرد سرور

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

cURL

Python

JavaScript

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

import requests

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

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

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

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

پاسخ نمونه

{
  "id": 12345,
  "name": "web-server-01",
  "hostname": "web01.example.com",
  "status": "active",
  "ip_address": "203.0.113.10",
  "ipv6_address": "2001:0db8::1",
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80,
    "bandwidth": 2048
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "resource_usage": {
    "cpu_percent": 23.5,
    "memory_used": 2048,
    "disk_used": 35,
    "bandwidth_used": 450
  },
  "created_at": "2025-01-10T14:30:00Z",
  "updated_at": "2025-01-16T15:45:00Z"
}

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

200	اطلاعات سرور با موفقیت بازیابی شد
401	غیرمجاز - توکن API نامعتبر است یا وجود ندارد
404	یافت نشد - سرور وجود ندارد

قرار دادن /api/v1/servers/{server_id}/

سرور را به‌روزرسانی کنید

پیکربندی سرور را به‌روزرسانی کنید. همه فیلدها الزامی هستند.

پارامترهای مسیر

Parameter	Type	Required	Description
`server_id`	integer	Yes	شناسه منحصر به فرد سرور

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

پارامتر	نوع	مورد نیاز	توضیحات
`name`	رشته	بله	نام سرور
`hostname`	رشته	بله	نام میزبان سرور (FQDN)
`backups_enabled`	بولی	بله	فعال/غیرفعال کردن پشتیبان‌گیری خودکار

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

cURL

Python

curl -X PUT "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": true
  }'

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": True
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

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

200	سرور با موفقیت به‌روزرسانی شد
400	درخواست بد - پارامترهای نامعتبر
404	یافت نشد - سرور وجود ندارد

پچ /api/v1/servers/{server_id}/

به‌روزرسانی جزئی سرور

فیلدهای خاص سرور را به‌روزرسانی کنید. فقط فیلدهای ارائه شده به‌روزرسانی خواهند شد.

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

cURL

Python

curl -X PATCH "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "new-server-name"
  }'

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"name": "new-server-name"}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

حذف /api/v1/servers/{server_id}/

حذف سرور

حذف دائمی سرور. این عمل قابل بازگشت نیست.

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

cURL

Python

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

import requests

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

response = requests.delete(url, headers=headers)
print(response.status_code)

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

204	سرور با موفقیت حذف شد
404	یافت نشد - سرور وجود ندارد

پست /api/v1/servers/{server_id}/start/

شروع سرور

روشن کردن سرور متوقف شده.

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

cURL

Python

JavaScript

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

import requests

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

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

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

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

پاسخ نمونه

{
  "status": "success",
  "message": "Server is starting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "starting"
  }
}

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

200	دستور شروع سرور با موفقیت ارسال شد
400	درخواست بد - سرور در حال اجرا است
404	یافت نشد - سرور وجود ندارد

پست /api/v1/servers/{server_id}/stop/

سرور را متوقف کنید

سرور در حال اجرا را با ظرافت خاموش کنید.

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

cURL

Python

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

import requests

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

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

پاسخ نمونه

{
  "status": "success",
  "message": "Server is stopping",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "stopping"
  }
}

پست /api/v1/servers/{server_id}/reboot/

راه اندازی مجدد سرور

سرور در حال اجرا را با ظرافت مجدداً راه‌اندازی کنید.

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

cURL

Python

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

import requests

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

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

پاسخ نمونه

{
  "status": "success",
  "message": "Server is rebooting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "rebooting"
  }
}

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

200	دستور راه‌اندازی مجدد سرور با موفقیت ارسال شد
400	درخواست بد - سرور در حال اجرا نیست
404	یافت نشد - سرور وجود ندارد

VPS.org API

API سرورها

لیست همه سرورها

پارامترهای پرس و جو

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

پاسخ نمونه

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

ایجاد سرور جدید

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

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

پاسخ نمونه

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

دریافت جزئیات سرور

پارامترهای مسیر

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

پاسخ نمونه

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

سرور را به‌روزرسانی کنید

پارامترهای مسیر

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

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

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

به‌روزرسانی جزئی سرور

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

حذف سرور

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

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

شروع سرور

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

پاسخ نمونه

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

سرور را متوقف کنید

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

پاسخ نمونه

راه اندازی مجدد سرور

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

پاسخ نمونه

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