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

सबै सर्भरहरू सूचीबद्ध गर्नुहोस्

क्वेरी प्यारामिटरहरू

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

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

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

नयाँ सर्भर सिर्जना गर्नुहोस्

अनुरोध बडी प्यारामिटरहरू

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

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

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

सर्भर विवरणहरू प्राप्त गर्नुहोस्

मार्ग प्यारामिटरहरू

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

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

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

सर्भर अपडेट गर्नुहोस्

मार्ग प्यारामिटरहरू

अनुरोध बडी प्यारामिटरहरू

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

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

आंशिक रूपमा सर्भर अपडेट गर्नुहोस्

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

सर्भर मेटाउनुहोस्

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

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

सर्भर सुरु गर्नुहोस्

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

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

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

सर्भर रोक्नुहोस्

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

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

सर्भर रिबुट गर्नुहोस्

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

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

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