සේවාදායක API

සියලුම සේවාදායක ලැයිස්තුගත කරන්න

ඔබේ ගිණුම තුළ සේවාදායකය, නවතම පළමු, පිටුවකට 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 USD) සේවාදායකය නිර්මාණය කිරීමට පෙර ඔබේ කාඩ්පත් තබා ගත හැක.

අවසර අවශ්‍යයි: 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 සේවාදායක විස්තර ලබා යටතේ විස්තර කරන පූර්ණ සේවාදායක වස්තුව සමග නිර්මාණය. ලිපින සහ vmid එක් වරක් යෙදවීම අවසන් දී පිරී ඇත.

{
  "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"
    }
  ]
}

SVG අයිකන මාකප් සහ සංස්කරණ ලැයිස්තුව මෙහි කෙටි කර ඇත.

ප්‍රතිචාර ක්ෂේත්‍ර

ප්‍රතිචාර තත්ව කේත

සේවාදායක තත්වය ලබාගන්න

ඔබ නිර්මාණය පසු, බලය හෝ ධාරකයක් ප්‍රතිසම කිරීම සඳහා ඡන්ද විමසීම සඳහා සැහැල්ලු ඇමතුමක්.

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"
}

ප්‍රතිචාර තත්ව කේත

ධාරකය ප්‍රතිප්‍රමාණ කරන්න

වෙනත් සක්‍රීය සැලැස්මකට සේවාදායකය ගෙන යයි. නව සැලැස්ම වත්මන් එකට වඩා අඩු තැටි ඉඩක් ඇති කළ නොහැකි, හා ඉල්ලීම ශරීරය නැවත ප්රමාණවත් කිරීමට සැකසූ ක්රියා ඇතුළත් විය යුතුය. නව සැලැස්ම සඳහා hypervisor ධාරිතාව කිසිවක් පෝලිමේ පෙර පරීක්ෂා කරනු ලැබේ, එබැවින් ප්රතික්ෂේප ඉල්ලීමක් සේවාදායකය වෙනස් නොකර තබා යයි.

එය ප්රමාණවත් වන අතර, පසුව නැවත ආරම්භ වන අතර සේවාදායකය වසා දමයි. ප්රමාණවත් අසාර්ථක නම්, සේවාදායකය එය ධාවනය නම් එහි පෙර සැලැස්ම මත නැවත තබා නැවත ආරම්භ කරනු ලැබේ. තැටි වර්ධනය අවලංගු කළ නොහැකි.

අවසර අවශ්‍යයි: 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"
}

ප්‍රතිචාර තත්ව කේත

root මුරපදය යළි සකසන්න

නව root මුරපදයක් ජනනය කරයි, එය ප්‍රතිචාරයේ දී ලබාදී සංග්‍රහකයේ වෙනස්වීම පෝලිමේ තබයි. නව මුරපදය ඔබට ඊමේල් මගින් ද යවයි. සංග්‍රහකය යෙදවිය යුතුයි. ඉල්ලුම් ශරීරය අවශ්ය නොවේ.

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"
}

ප්‍රතිචාර තත්ව කේත

ප්‍රතිවිරුද්ධ DNS (PTR)

GET සේවාදායකය මත සෑම IPv4 සහ IPv6 ලිපිනයන් ආපසු DNS ධාරක නාමය ලැයිස්තුගත කරයි. POST එක් ලිපිනයක් සඳහා එය සකස් කරයි. හිස් ධාරක නාමය යැවීම එහි පෙරනිමි ආපසු DNS නාමය වෙත ලිපිනය නැවත සකස් කරයි.

අවසර අවශ්‍යයි: 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"
}

GET පිලිතුර:

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

ප්‍රතිචාර තත්ව කේත

ධාරකයේ විධානයක් ක්‍රියාත්මක කරන්න

QEMU අමුත්තන් නියෝජිතයා හරහා ධාරකයේ ඇති ශෙල් විධානයක් ක්‍රියාත්මක කර එය අවසන් වන තෙක් බලා සිටියි. ධාරකය ස්ථාපනය කර ක්‍රියාත්මක විය යුතු අතර qemu- guest- agent ස්ථාපනය කර අමුත්තන් තුළ ක්‍රියාත්මක විය යුතුය.

අවසර අවශ්‍යයි: 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
}

විධාන තවමත් ක්රියාත්මක වේ නම්, timeout කල් ඉකුත් වන විට, ප්රතිචාරය timed_out සැබෑ කිරීමට සකස් කර ඇත හා null කිරීමට exit_code සකස් කර ඇත.

ප්‍රතිචාර තත්ව කේත

සේවාදායකය මකන්න

ස්ථිර මකනය සඳහා ධාරකය පෝලිමේ තබයි. ධාරකය ලැයිස්තුවෙන් වහාම අතුරුදන් වන අතර නැවත ලබාගත නොහැක.

අවසර අවශ්‍යයි: 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"
}

ප්‍රතිචාර තත්ව කේත

SSH යතුරු

ඔබේ ගිණුමේ පොදු SSH යතුරු ගබඩා, ඔබ සේවාදායකයක් නිර්මාණය කරන විට ssh_key_uuids ලෙස ඔවුන්ගේ uuids ගමන්. GET ඔබේ යතුරු ලැයිස්තුගත (පිටුවකට 25); POST එක් එකතු කරයි.

අවසර අවශ්‍යයි: 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
}

ප්‍රතිචාර ක්ෂේත්‍ර

ප්‍රතිචාර තත්ව කේත

SSH යතුර ලබාගන්න හෝ මකන්න

GET ඉහත ක්ෂේත්ර සමග එක් යතුරක් ආපසු. DELETE ඔබේ ගිණුම එය ඉවත් හා කිසිදු ශරීරය සමග 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/: උපස්ථ API
• POST /api/v1/servers/{uuid}/snapshot/: ස්නැප්ෂොට් API