सर्वर एपीआई

सभी सर्वरों की सूची

आपके खाते में सर्वर को नए, नए, 25 पेज पर बताता है. सर्वर जो मिटाई जा रही है, वे शामिल नहीं हैं.

अनुमति: servers:list

क्वेरी पैरामीटर

उदाहरण अनुरोध

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

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for server in response.json()["results"]:
    print(server["uuid"], server["hostname"], server["status"])

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

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

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

foreach ($data['results'] as $server) {
    echo $server['hostname'] . ' ' . $server['status'] . "\n";
}

उदाहरण प्रतिक्रिया

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
      "hostname": "web-01",
      "status": "on",
      "error_description": null,
      "location_name": "New Jersey",
      "plan_name": "1 vCPU / 2 GB RAM / 10 GB",
      "os_name": "Ubuntu",
      "ipv4_addresses": ["203.0.113.10"],
      "ipv6_addresses": ["2001:db8:2:dd::f9:6b"],
      "created_at": "2026-07-30T03:54:14.914364Z",
      "deployed": true
    },
    {
      "uuid": "2d7e9b40-6c1a-4f3e-8b5d-9a0c1e2f3b4d",
      "hostname": "db-01",
      "status": "queue",
      "error_description": null,
      "location_name": "New Jersey",
      "os_name": "Debian",
      "ipv4_addresses": [],
      "ipv6_addresses": [],
      "created_at": "2026-09-14T19:33:49.426508Z",
      "deployed": false
    }
  ]
}

प्रतिक्रिया क्षेत्र

प्रतिक्रिया स्थिति कोड

नया सर्वर बनाएँ

तैनाती के लिए एक नया सर्वर कतार के साथ कतार में बन्द करता है. व्यवस्थाबद्ध स्थिति सीमा पर जारी रहती है जब तक कि तैनात किया जाता है. जब सर्वर तैयार है तो इसका लॉगइन विवरण खाता मालिक को ई- मेल भेज दिया जाता है.

आपके खाते को एक सहेजा गया भुगतान विधि की आवश्यकता है. आपके खाते के इतिहास पर निर्भर करता है, योजना मूल्य के एक सप्ताह के बारे में एक अस्थायी पूर्वीकरण (कम 1 यूएस डी के अनुसार) आपके कार्ड को बनाने से पहले आपके कार्ड में डाल दिया जा सकता है.

अनुमति: servers:create

अनुरोध निकाय पैरामीटर

उदाहरण अनुरोध

curl -X POST "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "hostname": "web-01",
    "location_id": 1,
    "plan_uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
    "operating_system_version_uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "ssh_key_uuids": ["YOUR_SSH_KEY_UUID"]
  }'

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {
    "hostname": "web-01",
    "location_id": 1,
    "plan_uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
    "operating_system_version_uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "ssh_key_uuids": ["YOUR_SSH_KEY_UUID"],
}

response = requests.post(url, headers=headers, json=data)
server = response.json()
print(response.status_code, server["uuid"], server["status"])

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({
    hostname: 'web-01',
    location_id: 1,
    plan_uuid: '3bc2faf6-8f8b-4978-b62d-b52ed3f858e9',
    operating_system_version_uuid: 'c3418f90-80a0-4e00-a7e1-d0ab1822b941',
    ssh_key_uuids: ['YOUR_SSH_KEY_UUID']
  })
});

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

$data = [
    'hostname' => 'web-01',
    'location_id' => 1,
    'plan_uuid' => '3bc2faf6-8f8b-4978-b62d-b52ed3f858e9',
    'operating_system_version_uuid' => 'c3418f90-80a0-4e00-a7e1-d0ab1822b941',
    'ssh_key_uuids' => ['YOUR_SSH_KEY_UUID']
];

$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);

$server = json_decode(curl_exec($ch), true);
curl_close($ch);

उदाहरण प्रतिक्रिया

201 बनाया गया सर्वर विवरण के अंतर्गत वर्णित पूर्ण सर्वर वस्तु. पता और वीम्मी को एक बार तैनात किया जाता है.

{
  "uuid": "5f0c8e2a-6b1d-4c3e-9a7f-2d4b6c8e0a1f",
  "hostname": "web-01",
  "vmid": null,
  "status": "queue",
  "error_description": null,
  "location": {
    "id": 1,
    "name": "New Jersey",
    "country_name": "United States",
    "is_active": true
  },
  "plan": {
    "uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
    "cpu": 1,
    "ram": 2,
    "ram_unit": "GB",
    "disk_space": 10,
    "disk_space_total": 10240,
    "transfer": 500,
    "price": "3.50",
    "cpu_type_name": "Shared",
    "is_active": true,
    "hourly_price": "0.005",
    "monthly_price": "3.50",
    "is_gpu": false,
    "gpu_count": 0,
    "gpu_model": ""
  },
  "operating_system": {
    "id": 1,
    "name": "Ubuntu",
    "svg_icon": "<svg ...>",
    "versions": [ ... ]
  },
  "operating_system_version": {
    "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "name": "24.04 LTS x64",
    "os_name": "Ubuntu",
    "os_svg_icon": "<svg ...>",
    "is_active": true
  },
  "ipv4_addresses": [],
  "ipv6_addresses": [],
  "deployed": false,
  "created_at": "2026-09-14T21:02:11.402113Z",
  "recent_actions": []
}

प्रतिक्रिया स्थिति कोड

सर्वर विवरण प्राप्त करें

एक सर्वर इसके स्थान, योजना, ऑपरेटिंग सिस्टम, IP पता तथा पांच हाल के क्रियाओं के साथ वापस जाता है.

अनुमति: servers:list

curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

उदाहरण प्रतिक्रिया

{
  "uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
  "hostname": "web-01",
  "vmid": 1042,
  "status": "on",
  "error_description": null,
  "location": {
    "id": 1,
    "name": "New Jersey",
    "country_name": "United States",
    "is_active": true
  },
  "plan": {
    "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
    "cpu": 1,
    "ram": 2,
    "ram_unit": "GB",
    "disk_space": 25,
    "disk_space_total": 25600,
    "transfer": 1,
    "price": "5.00",
    "cpu_type_name": "Shared",
    "is_active": true,
    "hourly_price": "0.007",
    "monthly_price": "5.00",
    "is_gpu": false,
    "gpu_count": 0,
    "gpu_model": ""
  },
  "operating_system": {
    "id": 1,
    "name": "Ubuntu",
    "svg_icon": "<svg ...>",
    "versions": [ ... ]
  },
  "operating_system_version": {
    "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "name": "24.04 LTS x64",
    "os_name": "Ubuntu",
    "os_svg_icon": "<svg ...>",
    "is_active": true
  },
  "ipv4_addresses": [
    {
      "ip": "203.0.113.10",
      "gateway": "203.0.113.1",
      "subnet": "203.0.113.0",
      "rdns": "web-01.example.com"
    }
  ],
  "ipv6_addresses": [
    {
      "ip": "2001:db8:2:dd::f9:6b",
      "gateway": "2001:db8:2:dd::f9:1",
      "subnet": "2001:db8:2:dd::f9:0",
      "rdns": "web-01.example.com"
    }
  ],
  "deployed": true,
  "created_at": "2026-07-30T03:54:14.914364Z",
  "recent_actions": [
    {
      "id": 17028,
      "action": "create",
      "action_display": "Create",
      "description": "Server deployed with VMID 1042",
      "user_email": "you@example.com",
      "created_at": "2026-07-30T03:54:32.860854Z"
    }
  ]
}

एसवीजी प्रतीक मार्कअप तथा संस्करण सूची यहाँ छोटे ही हैं.

प्रतिक्रिया क्षेत्र

प्रतिक्रिया स्थिति कोड

सर्वर स्थिति प्राप्त करें

बनाने के बाद आप, ऊर्जा या सर्वर का आकार बदलने के लिए हल्का सा कॉल.

curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/status/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "status": "on",
  "deployed": true,
  "resizing": false
}

सर्वर स्थिति मान

सर्वर पावर नियंत्रण

क्रिया सम्पन्न होने तक सर्वर स्थिति परिवर्तनों को कतार में रखता है.

अनुमति: servers:power

अनुरोध निकाय पैरामीटर

उदाहरण अनुरोध

curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/power/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "restart"}'

import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/power/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"action": "restart"})
print(response.json())

उदाहरण प्रतिक्रिया

{
  "message": "Server restart queued"
}

प्रतिक्रिया स्थिति कोड

सर्वर को नया आकार दें

सर्वर को अन्य सक्रिय योजना में खिसकाता है. नया योजना मौजूदा स्थान कम नहीं कर सकता. निवेदन बॉडी में परिवर्तन के लिए क्रिया शामिल करना चाहिए. नई योजना के लिए हायपरविएंटर क्षमता जाँच की गई है, इसलिए सर्वर अप्रयोगित हो जाता है.

सर्वर बंद है जब तक कि यह आकार बदला नहीं जा सकता और उसके बाद फिर से प्रारंभ होता है. यदि इसका आकार खत्म होता है, सर्वर पिछले योजना पर वापस रख दिया जाता है और फिर से शुरू होता है. डिस्क विकास वापस नहीं किया जा सकता.

अनुमति: servers:resize

अनुरोध निकाय पैरामीटर

curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/resize/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "resize", "new_plan_uuid": "5e26a4a6-bd0c-467c-abca-da036c811c3f"}'

{
  "message": "Resize queued successfully"
}

अस्वीकृत किए गए आकार का उदाहरण (409):

{
  "error": "Not enough hypervisor capacity for the selected plan; the server was not changed"
}

प्रतिक्रिया स्थिति कोड

रूट पासवर्ड रीसेट करें

सर्वर पर परिवर्तन तथा कतार में लौटाता है. नया पासवर्ड आपके लिए भी मेल भेजा जाना चाहिए. सर्वर को तैनात किया जाना चाहिए. कोई भी निवेदन बॉडी की आवश्यकता नहीं है.

curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/reset-password/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "message": "Password reset queued. New password will also be emailed to you.",
  "password": "generated-password",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}

प्रतिक्रिया स्थिति कोड

उल्टा डीएनएस (आर)

सर्वर पर प्रत्येक आईपी4 तथा आईपीवी६ पता का उलटा नाम प्राप्त करें. इसे एक ही पता के लिए सेट किया जाता है. एक रिक्त होस्टनाम भेजने का पता इसके डिफ़ॉल्ट पर रीसेट करता है.

अनुमति: servers:update

अनुरोध निकाय पैरामीटर (POST)

curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/rdns/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ip": "203.0.113.10", "hostname": "mail.example.com"}'

{
  "message": "Reverse DNS for 203.0.113.10 set to mail.example.com",
  "ip": "203.0.113.10",
  "hostname": "mail.example.com"
}

जवाब प्राप्त करें:

{
  "rdns": [
    {"ip": "203.0.113.10", "hostname": "mail.example.com"},
    {"ip": "2001:db8:2:dd::f9:6b", "hostname": "mail.example.com"}
  ]
}

प्रतिक्रिया स्थिति कोड

सर्वर पर कमांड चलाएँ

क्यूईएम मेहमान एजेंट के माध्यम से सर्वर के अंदर एक शेल कमांड चलाता है और इसे पूरा करने के लिए इंतजार करता है. सर्वर को तैनात किया जाना चाहिए और चल रहा है, और que-e- localuP-P- local- localPP संस्थापित किया जाना चाहिए और मेहमान में चल रहा होगा.

अनुमति: servers:exec

अनुरोध निकाय पैरामीटर

curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/exec/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"command": "uptime", "timeout": 30}'

{
  "stdout": " 21:14:03 up 46 days,  2:10,  0 users,  load average: 0.08, 0.03, 0.01\n",
  "stderr": "",
  "exit_code": 0,
  "timed_out": false
}

यदि कमांड अभी भी चल रहा है जब समय समाप्त हो गया, अनुक्रिया सही पर सेट कर बाहर हो गया है तथा बाहर हों (_v).

प्रतिक्रिया स्थिति कोड

सर्वर हटाएं

स्थायी मिटाना के लिए सर्वर को कतार में डाला जाता है. सर्वर तत्काल सूची में से गायब हो जाता है और फिर इसे मिटाया नहीं जा सकता.

अनुमति: servers:delete

curl -X DELETE "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "message": "Server deletion queued"
}

प्रतिक्रिया स्थिति कोड

एसएसएच कुंजियाँ

आपके खाते में सार्वजनिक एसएसएच कुंजी भंडारित करें, तब उनके uk_ uids को uk_ uids के रूप में पास करते हुए su_BAR_S_uids जब आप एक सर्वर बनाते हैं. अपनी कुंजियाँ (25 पेज पर) सूची प्राप्त करें; PUCTC जोड़ता है

अनुमति: ssh-keys:list (GET), ssh-keys:create (POST)

अनुरोध निकाय पैरामीटर (POST)

उदाहरण अनुरोध

curl -X POST "https://admin.vps.org/api/v1/ssh-keys/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "laptop", "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... you@laptop"}'

import requests

url = "https://admin.vps.org/api/v1/ssh-keys/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

with open("/home/you/.ssh/id_ed25519.pub") as f:
    data = {"name": "laptop", "public_key": f.read().strip()}

response = requests.post(url, headers=headers, json=data)
print(response.status_code, response.json()["uuid"])

उदाहरण प्रतिक्रिया

{
  "id": 19,
  "uuid": "6e1b9c52-3f8a-4d7e-a2c4-5b9d0e1f2a3c",
  "name": "laptop",
  "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... you@laptop",
  "fingerprint": "0b:4c:9b:48:76:e7:1d:07:b9:ac:71:90:70:f7:9a:69",
  "created_at": "2026-08-23T19:16:11.547183Z",
  "last_used_at": null
}

प्रतिक्रिया क्षेत्र

प्रतिक्रिया स्थिति कोड

एसएसएच कुंजी को प्राप्त या मिटाएँ

ARERT कुंजी को ऊपर दिए क्षेत्र से बताता है. इसे मिटा कर आपके खाते से 204 हटाता है और आपके द्वारा कोई शरीर को नहीं मिटाता है. किसी कुंजी को सर्वर से हटाता है जो पहले से संस्थापित है. कुंजियाँ संपादित नहीं की जा सकती हैं.

अनुमति: ssh-keys:list (GET), ssh-keys:delete (DELETE)

curl -X DELETE "https://admin.vps.org/api/v1/ssh-keys/6e1b9c52-3f8a-4d7e-a2c4-5b9d0e1f2a3c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

बैकअप और स्नैपशॉट

बैकअप या स्नेपशॉट बनाया जा रहा है सर्वर क्रिया भी:

• POST /api/v1/servers/{uuid}/backup/: बैकअप एपीआई
• POST /api/v1/servers/{uuid}/snapshot/: स्नैपशॉट एपीआई