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`	عدد	ها	وي پي ايس پلان جي سڃاڻپ
`os_id`	عدد	ها	آپريٽنگ سسٽم جي سڃاڻپ
`location`	تار	ها	ڊيٽا سينٽر جي جڳھ جو ڪوڊ
`hostname`	تار	نه	سرور هوسٽ نالو (FQDN)
`ssh_key_id`	عدد	نه	انسٽال ڪرڻ لاءِ SSH ڪي آئي ڊي
`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

سڀني سرورن جي فهرست ڏيو

سوال جا پيرا ميٽر

مثال جي درخواست

مثال جواب

جوابي اسٽيٽس ڪوڊس

نئون سرور ٺاهيو

درخواست باڊي پيرا ميٽرز

مثال جي درخواست

مثال جواب

جوابي اسٽيٽس ڪوڊس

سرور جي تفصيل حاصل ڪريو

رستي جا پيرا ميٽر

مثال جي درخواست

مثال جواب

جوابي اسٽيٽس ڪوڊس

سرور کي اپڊيٽ ڪريو

رستي جا پيرا ميٽر

درخواست باڊي پيرا ميٽرز

مثال جي درخواست

جوابي اسٽيٽس ڪوڊس

جزوي طور تي سرور اپڊيٽ ڪريو

مثال جي درخواست

سرور ختم ڪريو

مثال جي درخواست

جوابي اسٽيٽس ڪوڊس

سرور شروع ڪريو

مثال جي درخواست

مثال جواب

جوابي اسٽيٽس ڪوڊس

سرور بند ڪريو

مثال جي درخواست

مثال جواب

سرور ريبوٽ ڪريو

مثال جي درخواست

مثال جواب

جوابي اسٽيٽس ڪوڊس