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 پلان کی ID
`os_id`	عدد	جی ہاں	آپریٹنگ سسٹم کی شناخت
`location`	تار	جی ہاں	ڈیٹا سینٹر لوکیشن کوڈ
`hostname`	تار	نہیں	سرور کا میزبان نام (FQDN)
`ssh_key_id`	عدد	نہیں	انسٹال کرنے کے لیے SSH کلیدی ID
`backups_enabled`	بولین	نہیں	خودکار بیک اپ کو فعال کریں (پہلے سے طے شدہ: غلط)

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

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`	عدد	جی ہاں	منفرد سرور 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	منفرد سرور ID

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

پیرامیٹر	قسم	درکار ہے۔	تفصیل
`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

تمام سرورز کی فہرست بنائیں

سوال کے پیرامیٹرز

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

مثال کا جواب

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

نیا سرور بنائیں

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

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

مثال کا جواب

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

سرور کی تفصیلات حاصل کریں۔

راستے کے پیرامیٹرز

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

مثال کا جواب

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

اپ ڈیٹ سرور

راستے کے پیرامیٹرز

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

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

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

جزوی طور پر اپ ڈیٹ سرور

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

سرور کو حذف کریں۔

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

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

سرور شروع کریں۔

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

مثال کا جواب

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

سٹاپ سرور

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

مثال کا جواب

ریبوٹ سرور

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

مثال کا جواب

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