VPS.org API

REST API ഡോക്യുമെന്റേഷൻ

സെർവറുകൾ API

നിങ്ങളുടെ VPS സെർവറുകൾ പ്രോഗ്രമാറ്റിക്കായി കൈകാര്യം ചെയ്യുക. നിങ്ങളുടെ വെർച്വൽ പ്രൈവറ്റ് സെർവറുകൾ സൃഷ്ടിക്കുക, കോൺഫിഗർ ചെയ്യുക, നിയന്ത്രിക്കുക, നിരീക്ഷിക്കുക.

എൻഡ്‌പോയിന്റുകൾ 9
ബേസ് പാത്ത് /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 പൂർണ്ണസംഖ്യ അതെ VPS പ്ലാനിന്റെ ഐഡി
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 കണ്ടെത്തിയില്ല - സെർവർ നിലവിലില്ല.