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/v1/servers/

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

निर्दिष्ट कॉन्फ़िगरेशन के साथ एक नया VPS सर्वर तैनात करें।

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

पैरामीटर	प्रकार	आवश्यक	विवरण
`name`	डोरी	हाँ	सर्वर का नाम (वर्णमाला, हाइफ़न की अनुमति है)
`plan_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	अनधिकृत - अमान्य या अनुपलब्ध एपीआई टोकन
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	अनधिकृत - अमान्य या अनुपलब्ध एपीआई टोकन
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

सर्वर एपीआई

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

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

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

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

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

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

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

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

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

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

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

पथ पैरामीटर

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

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

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

सर्वर अपडेट करें

पथ पैरामीटर

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

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

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

सर्वर को आंशिक रूप से अपडेट करें

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

सर्वर हटाएं

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

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

सर्वर शुरू करें

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

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

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

सर्वर बंद करें

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

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

सर्वर को रीबूट करें

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

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

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