VPS.org API

REST API ডকুমেন্টেশন

সার্ভার এপিআই

আপনার VPS সার্ভারগুলি প্রোগ্রাম্যাটিকভাবে পরিচালনা করুন। আপনার ভার্চুয়াল প্রাইভেট সার্ভারগুলি তৈরি করুন, কনফিগার করুন, নিয়ন্ত্রণ করুন এবং নিরীক্ষণ করুন।

শেষবিন্দু 9 endpoints
বেস পাথ /api/v1/servers
পান /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 পূর্ণসংখ্যা হাঁ অনন্য সার্ভার আইডি

উদাহরণ অনুরোধ

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 পাওয়া যায়নি - সার্ভারের অস্তিত্ব নেই