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`	पूर्णांक	होय	युनिक सर्व्हर आयडी

उदाहरण विनंती

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	सापडले नाही - सर्व्हर अस्तित्वात नाही.

VPS.org API

सर्व्हर API

सर्व सर्व्हरची यादी करा

क्वेरी पॅरामीटर्स

उदाहरण विनंती

उदाहरण प्रतिसाद

प्रतिसाद स्थिती कोड

नवीन सर्व्हर तयार करा

बॉडी पॅरामीटर्सची विनंती करा

उदाहरण विनंती

उदाहरण प्रतिसाद

प्रतिसाद स्थिती कोड

सर्व्हर तपशील मिळवा

पथ पॅरामीटर्स

उदाहरण विनंती

उदाहरण प्रतिसाद

प्रतिसाद स्थिती कोड

सर्व्हर अपडेट करा

पथ पॅरामीटर्स

बॉडी पॅरामीटर्सची विनंती करा

उदाहरण विनंती

प्रतिसाद स्थिती कोड

सर्व्हर अंशतः अपडेट करा

उदाहरण विनंती

सर्व्हर हटवा

उदाहरण विनंती

प्रतिसाद स्थिती कोड

सर्व्हर सुरू करा

उदाहरण विनंती

उदाहरण प्रतिसाद

प्रतिसाद स्थिती कोड

सर्व्हर थांबवा

उदाहरण विनंती

उदाहरण प्रतिसाद

सर्व्हर रीबूट करा

उदाहरण विनंती

उदाहरण प्रतिसाद

प्रतिसाद स्थिती कोड