VPS.org API

ເອກະສານ REST API

API ຂອງເຊີບເວີ

ສ້າງ, ກວດເບິ່ງ, ພະລັງງານ, ປ່ຽນຂະຫນາດ ແລະລຶບ ເຊີເວີ VPS ຂອງທ່ານ. ເຊີເວີແມ່ນຖືກລະບຸໂດຍ uuid ຂອງເຂົາເຈົ້າ.

ຈຸດສິ້ນສຸດ 15
ເສັ້ນທາງພື້ນຖານ /api/v1/servers
ຮັບ /api/v1/servers/

ລາຍຊື່ເຊີບເວີທັງໝົດ

ສົ່ງ​ຄືນ​ເຊີບເວີ​ໃນ​ບັນຊີ​ຂອງທ່ານ, ໃຫມ່​ກ່ອນ, 25 ຕໍ່​ຫນ້າ. ເຊີບເວີ​ທີ່​ຖືກ​ລຶບ​ອອກ​ບໍ່​ໄດ້​ລວມ​ເຂົ້າ​ກັນ​ໄດ້.

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:list

ພາລາມິເຕີການສອບຖາມ

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
page integer ​ບໍ່ ຕົວເລກ​ໜ້າ, ເລີ່ມ​ຈາກ 1
page_size integer ​ບໍ່ ຜົນ​ທີ່​ໄດ້​ຮັບ​ຕໍ່​ໜ້າ (ປັ​ດ​ເດີມ 25, ສູງສຸດ 100)

ຕົວຢ່າງການຮ້ອງຂໍ

cURL
Python
JavaScript
PHP
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
    }
  ]
}

ພາກສະໜາມຕອບສະໜອງ

​ແຄມ​ເປນ ປະເພດ ຄໍາອະທິບາຍ
uuid string ຕົວລະບຸ​ເຄື່ອງ​ແມ່ຂ່າຍ​ທີ່​ໃຊ້​ໃນ​ຈຸດ​ສຸດ​ທ້າຍ​ຂອງ​ເຄື່ອງ​ແມ່ຂ່າຍ​ອື່ນ
hostname string ຊື່​ເຄື່ອງ​ທີ່​ທ່ານ​ເລືອກ​ເມື່ອ​ສ້າງ​ເຄື່ອງ​ເຊີບເວີ
status string ສະຖານະ​ປັດຈຸບັນ. ເບິ່ງ​ຄ່າ​ສະຖານະ​ຂອງ​ເຄື່ອງ​ບໍລິການ​ຂ້າງລຸ່ມນີ້.
error_description string | null ລາຍລະອຽດ​ຂອງ​ການລົ້ມເຫລວ​ຄັ້ງ​ສຸດທ້າຍ ເມື່ອ​ສະຖານະ​ແມ່ນ​ຂໍ້ຜິດພາດ, ຖ້າ​ບໍ່ດັ່ງນັ້ນ ບໍ່ມີ
location_name string ຊື່​ຂອງ​ຕໍາແຫນ່ງ​ທີ່​ເຊີບເວີ​ແລ່ນ​ຢູ່
os_name string ຊື່​ລະບົບ​ປະຕິບັດການ, ບໍ່ມີ​ສະບັບ
plan_name string ບົດສະຫຼຸບແຜນທີ່ອ່ານໄດ້, ຕົວຢ່າງ 1 vCPU /2GB RAM / 10 GB
ipv4_addresses array ທີ່ຢູ່ IPv4 ເປັນ​ຂໍ້ຄວາມ​ສັ້ນໆ. ບໍ່ມີ​ຫຍັງຈົນກວ່າ​ຈະ​ມີ​ການ​ເປີດ​ໃຊ້​ບໍລິການ ແລະ ແຜນ​ທີ່​ບໍ່ມີ IPv4.
ipv6_addresses array ທີ່ຢູ່ IPv6 ເປັນ​ຂໍ້ຄວາມ​ສັ້ນໆ. ບໍ່​ມີ​ຫຍັງ​ຈົນ​ກວ່າ​ຈະ​ເປີດ​ໃຊ້​ບໍລິການ​ໄດ້.
created_at datetime ເວລາ​ສ້າງ (ISO 8601, UTC)
deployed boolean ຖືກ​ເມື່ອ​ການ​ຈັດການ​ໄດ້​ສຳເລັດ

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ດຶງຂໍ້ມູນລາຍຊື່ເຊີບເວີສຳເລັດແລ້ວ
403 API token ຂາດ ຫຼື ບໍ່ຖືກຕ້ອງ, ຫຼື token ບໍ່ມີສິດທີ່ຕ້ອງການ
ສົ່ງ /api/v1/servers/

ສ້າງເຊີບເວີໃໝ່

ຈັດ​ເຊີບເວີ​ໃໝ່​ເປັນ​ລໍາດັບ​ເພື່ອ​ໃຊ້​ງານ ແລະ ສົ່ງ​ຄືນ​ທັນທີ​ດ້ວຍ​ສະຖານະ​ລໍາດັບ​ທີ່​ມີ​ຢູ່​ແລ້ວ. ການ​ຈັດ​ຕັ້ງ​ປະຕິບັດ​ຈະ​ສືບຕໍ່​ຢູ່​ໃນ​ພື້ນ​ຫຼັງ: ຖາມ​ສະຖານະ​ຈຸດ​ສຸດ​ທ້າຍ​ຈົນ​ກວ່າ​ຈະ​ໃຊ້​ງານ​ໄດ້​ເຖິງ​ແມ່ນ​ວ່າ​ເປັນ​ຈິງ. ເມື່ອ​ເຊີບເວີ​ພ້ອມ, ລາຍລະອຽດ​ການ​ເຂົ້າ​ສູ່​ລະບົບ​ຈະ​ຖືກ​ສົ່ງ​ອີເມວ​ໄປ​ຫາ​ເຈົ້າ​ຂອງ​ບັນຊີ.

ບັນຊີຂອງທ່ານຕ້ອງການວິທີການຈ່າຍເງິນທີ່ເກັບໄວ້. ອີງຕາມປະຫວັດຂອງບັນຊີຂອງທ່ານ, ການອະນຸຍາດກ່ອນການອະນຸຍາດຊົ່ວຄາວຂອງລາຄາແຜນປະມານອາທິດ ໜຶ່ງ (ຢ່າງໜ້ອຍ 1 USD) ສາມາດຖືກວາງໄວ້ໃນບັດຂອງທ່ານກ່ອນທີ່ເຊີບເວີຈະຖືກສ້າງຂຶ້ນ.

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:create

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
hostname string ແມ່ນແລ້ວ ຢ່າງໜ້ອຍ3ຕົວອັກສອນ. ມີ​ແຕ່​ຕົວອັກສອນ, ຕົວເລກ, ຕົວ​ຢຽບ ແລະ ຈຸດເທົ່ານັ້ນ.
location_id integer ແມ່ນແລ້ວ ຕົວ​ເລກ​ຂອງ​ສະຖານທີ່​ທີ່​ມີ​ຢູ່​ຈາກ​ Locations API
plan_uuid string ແມ່ນແລ້ວ uuid ຂອງ​ແຜນທີ່​ມີ​ການ​ໃຊ້​ງານ​ຈາກ API ຂອງ​ແຜນ
operating_system_version_uuid string ແມ່ນແລ້ວ uuid ຂອງ​ລາຍການ​ທີ່​ມີ​ຢູ່​ໃນ​ລາຍຊື່​ລຸ້ນ​ຂອງ​ລະບົບ​ປະຕິບັດການ
ssh_key_uuids array ​ບໍ່ UUID ຂອງ​ກູ​ບ SSH ຈາກ API ຂອງ​ກູບ SSH ເພື່ອ​ຕິດຕັ້ງ​ໃສ່​ເຊີບເວີ
ssh_key_ids array ​ບໍ່ ຕົວລະບຸຕົວເຕັມຂອງກູໂກ SSH, ເປັນຕົວເລືອກອື່ນຂອງ ssh_key_uuids. ຖ້າທັງສອງຖືກສົ່ງ, ssh_key_ids ຈະຖືກໃຊ້.
ssh_key_uuid, ssh_key_id string, integer ​ບໍ່ ຕົວອັກສອນ​ສັ້ນ ສຳ​ລັບ​ກູ​ໂກ SSH ດຽວ
auth_method string ​ບໍ່ ລະຫັດຜ່ານ, ssh_key ຫຼືທັງສອງ. ແບບ​ເດີມແມ່ນ​ລະຫັດຜ່ານ ຫຼືທັງສອງເມື່ອ​ມີ​ລະຫັດຜ່ານ SSH.

ຕົວຢ່າງການຮ້ອງຂໍ

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 '{
    "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 ສ້າງ​ຂຶ້ນ​ດ້ວຍ​ສິ່ງ​ຂອງ​ເຊີບເວີ​ເຕັມ​ທີ່​ໄດ້​ອະທິບາຍ​ໄວ້​ໃນ Get Server Details. ທີ່ຢູ່ ແລະ 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": []
}

ລະຫັດສະຖານະການຕອບສະໜອງ

201 ສ້າງ​ເຄື່ອງ​ຮັບ​ແລະ​ລໍຖ້າ​ການ​ເປີດ​ໃຊ້​ງານ
400 ການກວດສອບ​ຄວາມຜິດພາດ, ຕົວຢ່າງ ສະຖານທີ່​ທີ່​ບໍ່​ມີ​ການເຄື່ອນໄຫວ, ແຜນ ຫຼື ສະບັບ​ຂອງ​ລະບົບ​ປະຕິບັດການ
402 ບໍ່ມີ​ວິທີ​ການ​ຈ່າຍ​ເງິນ​ໃນ​ໄຟລ໌, ໃບ​ແຈ້ງ​ການ​ທີ່​ບໍ່​ໄດ້​ຈ່າຍ ຫຼື ການ​ອະນຸຍາດ​ກ່ອນ​ການ​ໃຊ້​ບັດ​ໄດ້​ຖືກ​ປະຕິເສດ
403 API token ຂາດ ຫຼື ບໍ່ຖືກຕ້ອງ, ຫຼື token ບໍ່ມີສິດທີ່ຕ້ອງການ
429 ບັນຊີ​ຂອງທ່ານ​ໄດ້​ຮອດ​ຂີດ​ຈຳກັດ​ການ​ສ້າງ​ເຄື່ອງ​ເຊີບເວີ
ຮັບ /api/v1/servers/{uuid}/

ຮັບລາຍລະອຽດເຊີບເວີ

ສົ່ງ​ຄືນ​ເຄື່ອງ​ບໍລິການ​ດຽວ​ກັບ​ສະຖານທີ່, ແຜນ, ລະບົບ​ປະຕິບັດການ, ທີ່ຢູ່ 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 ແລະ ລາຍຊື່​ສະບັບ​ຖືກ​ຫຍໍ້​ຢູ່​ທີ່ນີ້.

ພາກສະໜາມຕອບສະໜອງ

​ແຄມ​ເປນ ປະເພດ ຄໍາອະທິບາຍ
vmid integer | null ຕົວເລກ​ຂອງ​ເຄື່ອງ​ເສມືນ, ຕັ້ງ​ເມື່ອ​ເປີດ​ໃຊ້
location object ຕົວ​ຢ່າງ​ສະຖານທີ່, ຕາມ​ທີ່​ໄດ້​ກັບ​ຄືນ​ໂດຍ​ Locations API
plan object ວັດຖຸ​ແຜນ, ຕາມ​ທີ່​ໄດ້​ຮັບ​ຄືນ​ຈາກ API ແຜນ
operating_system, operating_system_version object ລະບົບ​ປະຕິບັດການ ແລະ ສະບັບ​ທີ່​ໄດ້​ຕິດຕັ້ງ, ຕາມ​ທີ່​ໄດ້​ກັບ​ຄືນ​ໂດຍ​ API ຂອງ​ລະບົບ​ປະຕິບັດການ
ipv4_addresses, ipv6_addresses array ຕົວ​ຢ່າງ​ໜຶ່ງ​ຕໍ່​ທີ່ຢູ່​ທີ່​ມີ ip, gateway, subnet ແລະ rdns (ຊື່​ເຄື່ອງ DNS ກົງກັນຂ້າມ)
recent_actions array ເຖິງ5ການ​ເຮັດ​ໃໝ່: id, action, action_ display, description, user_ email, created_ at

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ດຶງຂໍ້ມູນລາຍລະອຽດເຊີບເວີສຳເລັດແລ້ວ
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ
ຮັບ /api/v1/servers/{uuid}/status/

​ຮັບ​ສະຖານະ​ម៉ាស៊ីន​បម្រើ

ການ​ໂທ​ທີ່​ເບົາ​ສຳລັບ​ການ​ປ່ອນ​ບັດ ຫຼັງຈາກ​ທີ່​ທ່ານ​ສ້າງ, ເປີດ ຫຼື ປ່ຽນ​ຂະໜາດ​ຂອງ​ເຊີບເວີ.

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
}

ຄ່າ​ສະຖານະ​ម៉ាស៊ីន​បម្រើ

ຄ່າ ຄໍາອະທິບາຍ
queue An action (deploy, power, resize, restore) is queued or in progress
deploying ກຳລັງ​ຈັດ​ຕັ້ງ​ໄວ້. ម៉ាស៊ីន​ບິນ​ທີ່​ໄດ້​ສ້າງ​ຈາກ​ແຜງ​ຄວບຄຸມ ໃຊ້​ສະຖານະ​ນີ້; ម៉ាស៊ីន​ບິນ​ທີ່​ໄດ້​ສ້າງ​ຜ່ານ API ຕັ້ງ​ຢູ່​ໃນ​ລໍາຈົນ​ກວ່າ​ຈະ​ພ້ອມ.
on កំពុង​រត់
off ປິດ​ໄຟ
error ການກະທຳ​ສຸດ​ທ້າຍ​ລົ້ມ​ເຫຼວ. ເບິ່ງ error_description.
suspended_payment ຖືກຢຸດຊົ່ວຄາວ ຍ້ອນ​ວ່າ​ມີ​ໃບ​ແຈ້ງ​ການ​ທີ່​ບໍ່​ໄດ້​ຈ່າຍ
ສົ່ງ /api/v1/servers/{uuid}/power/

ຄວບຄຸມ​ພະລັງງານ​ຂອງ​ម៉ាស៊ីន​បម្រើ

ຈັດ​ການ​ໃຊ້​ງານ​ຂອງ​ພະລັງ​ງານ​ເປັນ​ລໍາດັບ ។ ສະຖານະ​ຂອງ​ម៉ាស៊ីន​ບິນ​ປ່ຽນ​ເປັນ​ລໍາດັບ​ຈົນ​ກວ່າ​ການ​ປະຕິບັດ​ງານ​ຈະ​ສຳເລັດ ។

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:power

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
action string ແມ່ນແລ້ວ start: ເປີດ​ໄຟ
shutdown: ການ​ປິດ​ທີ່​ມີ​ຄວາມ​ງາມ, ຖືກ​ບັງຄັບ​ໃຫ້​ປິດ​ຖ້າ​ແຂກ​ບໍ່​ຢຸດ
restart: ວົງຈອນ​ພະລັງງານ​ຮາດ (ຢຸດ, ຫຼັງຈາກນັ້ນ​ເລີ່ມ)
stop: ປັດຈຸບັນ​ໄດ້​ປະຕິບັດ​ການ​ໃຊ້​ພະລັງງານ​ຄື​ກັນ​ກັບ​ການ​ເລີ່ມຕົ້ນ​ຄືນ​ໃໝ່. ໃຊ້ shutdown ເພື່ອ​ປິດ​ເຊີບເວີ.

ຕົວຢ່າງການຮ້ອງຂໍ

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

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ການກະທໍາ​ຖືກ​ຈັດ​ເປັນ​ລໍາດັບ
400 ຂາດ ຫຼື ບໍ່​ໄດ້​ຮອງຮັບ​ການ​ປະຕິບັດ
402 ເລີ່ມ​ຕົ້ນ​ຖືກ​ປະຕິເສດ​ເພາະ​ບັນຊີ​ມີ​ໃບ​ແຈ້ງ​ການ​ທີ່​ບໍ່​ໄດ້​ຈ່າຍ
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ
ສົ່ງ /api/v1/servers/{uuid}/resize/

ປ່ຽນ​ຂະ​ໜາດ​ម៉ាស៊ីន​ບິນ

ຍ້າຍ​ເຄື່ອງ​ບໍລິການ​ໄປ​ຍັງ​ແຜນ​ທີ່​ມີ​ການ​ເຮັດ​ວຽກ​ອື່ນ ។ ແຜນ​ທີ່​ໃໝ່​ບໍ່​ສາມາດ​ມີ​ພື້ນທີ່​ດີສອກ​ນ້ອຍ​ກວ່າ​ແຜນ​ທີ່​ມີ​ການ​ເຮັດ​ວຽກ​ປັດຈຸບັນ ແລະ ຕົວ​ແບບ​ການ​ຮ້ອງຂໍ​ຕ້ອງ​ລວມ​ການ​ປະຕິບັດ​ງານ​ທີ່​ໄດ້​ຕັ້ງຄ່າ​ເພື່ອ​ປ່ຽນ​ຂະ​ໜາດ ។ ຄວາມ​ສາມາດ​ຂອງ Hypervisor ສຳ​ລັບ​ແຜນ​ທີ່​ໃໝ່ ແມ່ນ​ຖືກ​ກວດ​ສອບ​ກ່ອນ​ທີ່​ຈະ​ຈັດ​ເປັນ​ລໍາດັບ, ສະນັ້ນ​ການ​ຮ້ອງຂໍ​ທີ່​ບໍ່​ໄດ້​ຮັບ​ການ​ຍອມຮັບ ຈະ​ບໍ່​ປ່ຽນແປງ​ເຄື່ອງ​ບໍລິການ​ເລີຍ ។

ເຊີເວີ​ຈະ​ຖືກ​ປິດ​ລົງ ໃນຂະນະທີ່​ມັນ​ຖືກ​ປ່ຽນ​ຂະໜາດ ແລະ ເລີ່ມ​ຕົ້ນ​ຄືນ​ໃໝ່​ຫຼັງຈາກ​ນັ້ນ. ຖ້າ​ການ​ປ່ຽນ​ຂະໜາດ​ລົ້ມເຫລວ, ເຊີເວີ​ຈະ​ຖືກ​ວາງ​ຄືນ​ສູ່​ແຜນ​ກ່ອນ ແລະ ເລີ່ມ​ຕົ້ນ​ຄືນ​ໃໝ່ ຖ້າ​ມັນ​ໄດ້​ແລ່ນ​ຢູ່. ການ​ຂະຫຍາຍ​ຂອງ​ດາວ​ທຽມ​ບໍ່ສາມາດ​ຖອນ​ຄືນ​ໄດ້.

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:resize

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
action string ແມ່ນແລ້ວ ຕ້ອງ​ໄດ້​ປ່ຽນ​ຂະ​ໜາດ
new_plan_uuid string ແມ່ນແລ້ວ uuid ຂອງ​ແຜນທີ່​ຈະ​ເຄື່ອນ​ໄຫວ​ໄປ 
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"
}

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ການກະທໍາ​ຖືກ​ຈັດ​ເປັນ​ລໍາດັບ
400 ຂາດ​ການ​ປະຕິບັດ ຫຼື new_plan_uuid, ແຜນທີ່​ບໍ່​ຖືກຕ້ອງ ຫຼື ບໍ່​ສະ​ໝັກ, ແຜນທີ່​ມີ​ພື້ນທີ່​ດັ້ງ​ເດີມ​ໜ້ອຍ, ຫຼື ແຜນ GPU (ແຜນ GPU ບໍ່ສາມາດ​ປ່ຽນ​ຂະ​ໜາດ​ຜ່ານ API)
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ
409 ການ​ປ່ຽນ​ຂະ​ໜາດ ຫຼື ການ​ເກັບ​ຂໍ້ມູນ​ແມ່ນ​ໄດ້​ເລີ່ມ​ຕົ້ນ​ແລ້ວ ຫຼື ບໍ່ມີ​ຄວາມ​ສາມາດ​ຂອງ hypervisor ພຽງພໍ​ສຳລັບ​ແຜນ​ໃໝ່
503 ບໍ່ສາມາດ​ກວດເບິ່ງ​ຄວາມ​ຈຸ​ໄດ້​ໃນ​ປັດຈຸບັນ. ເຊີເວີ​ບໍ່​ໄດ້​ປ່ຽນແປງ, ພະຍາຍາມ​ອີກ​ຄັ້ງ​ໃນ​ອະນາຄົດ.
ສົ່ງ /api/v1/servers/{uuid}/reset-password/

ຕັ້ງ​ຄືນ​ລະຫັດ​ຜ່ານ​ຂອງ 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"
}

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ການກະທໍາ​ຖືກ​ຈັດ​ເປັນ​ລໍາດັບ
400 ຍັງບໍ່ໄດ້​ເປີດ​ຕົວ​ເຊີບເວີ​ເທື່ອ
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ
ຮັບ ສົ່ງ /api/v1/servers/{uuid}/rdns/

DNS ກົງກັນຂ້າມ (PTR)

GET ລາຍ​ງານ​ຊື່​ເຄື່ອງ DNS ກົງ​ກັນຂ້າມ​ຂອງ IPv4 ແລະ IPv6 ທີ່ຢູ່​ທຸກ​ຢ່າງ​ໃນ​ເຄື່ອງ​ແມ່ຂ່າຍ. POST ຕັ້ງ​ມັນ​ໄວ້​ໃນ​ທີ່ຢູ່​ດຽວ. ການ​ສົ່ງ​ຊື່​ເຄື່ອງ​ທີ່​ບໍ່​ມີ​ຫຍັງ​ຈະ​ເຮັດ​ໃຫ້​ທີ່ຢູ່​ກັບ​ຄືນ​ໄປ​ທີ່​ຊື່ DNS ກົງກັນຂ້າມ​ແບບ​ເດີມ​ຂອງ​ມັນ.

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:update

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ (POST)

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
ip string ແມ່ນແລ້ວ ທີ່ຢູ່ IPv4 ຫຼື IPv6 ທີ່​ໄດ້​ມອບ​ໃຫ້​ກັບ​ເຄື່ອງ​ບໍລິການ​ນີ້
hostname string ​ບໍ່ ຊື່​ເຄື່ອງ PTR. ទុក​ໃຫ້​ຫວ່າງ ເພື່ອ​ຕັ້ງ​ຄືນ​ເປັນ​ປັ້​ນ​ເດີມ. 
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"}
  ]
}

ລະຫັດສະຖານະການຕອບສະໜອງ

400 ບໍ່ມີ​ທີ່ຢູ່ ip ຫຼື ບໍ່​ສາມາດ​ຕັ້ງຊື່​ເຄື່ອງ​ໄດ້
404 ທີ່ຢູ່ IP ບໍ່​ໄດ້​ຖືກ​ມອບ​ໃຫ້​ກັບ​ເຄື່ອງ​ເຊີບເວີ​ນີ້
ສົ່ງ /api/v1/servers/{uuid}/exec/

ປະຕິບັດ​ຄໍາ​ສັ່ງ​ຢູ່​ເທິງ​ម៉ាស៊ីន​ບິນ

ປະຕິບັດ​ຄໍາ​ສັ່ງ​ສໍລ໌​ໃນ​ເຊີເວີ​ຜ່ານ​ຕົວແທນ​ແຂກ QEMU ແລະ រង់ចាំ​ໃຫ້​ມັນ​ສຳເລັດ. ເຊີເວີ​ຕ້ອງ​ໄດ້​ຖືກ​ເປີດ​ໃຊ້ ແລະ ແລ່ນ, ແລະ qemu- guest- agent ຕ້ອງ​ໄດ້​ຖືກ​ຕິດຕັ້ງ ແລະ ແລ່ນ​ໃນ​ແຂກ.

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:exec

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
command string ແມ່ນແລ້ວ ຄໍາສັ່ງ​ລໍາດັບ​ປະຕິບັດ​ກັບ /bin/sh -c, ເຖິງ 2000 ຕົວອັກສອນ
timeout integer ​ບໍ່ ຈໍານວນວິນາທີທີ່ຕ້ອງລໍຖ້າຄໍາສັ່ງ, 1 ຫາ 300 (ຕົວ​ແບບ​ເດີມ 30) 
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
}

ຖ້າ​ຄໍາ​ສັ່ງ​ຍັງ​ສືບຕໍ່​ປະຕິບັດ​ຢູ່ ເມື່ອ​ເວລາ​ໝົດ​ອາຍຸ, ການ​ຕອບ​ໂຕ້​ຈະ​ມີ timed_out ຕັ້ງ​ເປັນ true ແລະ exit_code ຕັ້ງເປັນ null.

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ຄໍາ​ສັ່ງ​ໄດ້​ສິ້ນສຸດ ຫຼື ເວລາ​ໝົດ​ໄປ
400 ម៉ាស៊ីន​ບິນ​ບໍ່​ໄດ້​ຈັດ​ຕັ້ງ​ໃຊ້ ຫຼື ບໍ່​ໄດ້​ແລ່ນ, ຫຼື ພາຣາມິເຕີ​ບໍ່​ຖືກຕ້ອງ
409 ຕົວແທນ​ແຂກ QEMU ບໍ່​ໄດ້​ແລ່ນ​ຢູ່​ເທິງ​ເຊີບເວີ
503 ບັນຫາ​ການ​ເຊື່ອມຕໍ່​ຊົ່ວຄາວ. ພະຍາຍາມ​ອີກ​ຄັ້ງ​ຫຼັງຈາກ​ຫົວ Retry- After.
ລຶບ /api/v1/servers/{uuid}/

ລຶບເຊີບເວີ

ຈັດ​ເຊີບເວີ​ເປັນ​ລໍາດັບ​ເພື່ອ​ລຶບ​ໄວ້​ເປັນ​ນິ້ວມື ។ ເຊີບເວີ​ຈະ​ຫາຍໄປ​ຈາກ​ລາຍການ​ທັນທີ ແລະ ບໍ່ສາມາດ​ຟື້ນ​ຟູ​ໄດ້ ។

ຕ້ອງການ​ສິດ​ອຳນາດ: 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"
}

ລະຫັດສະຖານະການຕອບສະໜອງ

202 ຍອມຮັບ: ຄໍາຮ້ອງຂໍ​ໄດ້​ຖືກ​ຈັດ​ເປັນ​ລໍາດັບ
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ
ຮັບ ສົ່ງ /api/v1/ssh-keys/

កូនសោ SSH

ເກັບ​ກູ​ບ​ SSH ສາທາລະນະ​ໄວ້​ໃນ​ບັນຊີ​ຂອງທ່ານ, ແລ້ວ​ສົ່ງ​ລະຫັດ​uuids ຂອງ​ພວກ​ມັນ​ເປັນ ssh_key_uuids ເມື່ອ​ທ່ານ​ສ້າງ​ເຊີບເວີ. GET ລາຍ​ຊື່​ກູບ​ຂອງທ່ານ (25 ຕໍ່​ໜ້າ); POST ເພີ່ມ​ອັນ​ໜຶ່ງ.

ຕ້ອງການ​ສິດ​ອຳນາດ: ssh-keys:list (GET), ssh-keys:create (POST)

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ (POST)

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
name string ແມ່ນແລ້ວ ຊື່​ທີ່​ຈະ​ຮັບຮູ້​ກູ​ບ, ເຖິງ 100 ຕົວອັກສອນ
public_key string ແມ່ນແລ້ວ ກູ​ບ​ສາທາລະນະ​ໃນ​ຮູບແບບ OpenSSH, ຕົວຢ່າງ​ເນື້ອໃນ​ຂອງ id_ed25519.pub

ຕົວຢ່າງການຮ້ອງຂໍ

cURL
Python
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
}

ພາກສະໜາມຕອບສະໜອງ

​ແຄມ​ເປນ ປະເພດ ຄໍາອະທິບາຍ
id, uuid integer, string ຕົວລະບຸ​ກູ​ບ. ໃຊ້ uuid ໃນ ssh_key_uuids ແລະ URL ຂ້າງລຸ່ມນີ້; id ເຮັດວຽກໃນ ssh_key_ids.
fingerprint string ນິ້ວມື MD5 ຂອງກ່ອງ, ຄິດໄລ່ໂດຍ​ເວບໄຊທ໌
last_used_at datetime | null ເມື່ອ​ປຸ່ມ​ຖືກ​ຕິດຕັ້ງ​ຄັ້ງ​ສຸດທ້າຍ​ໃນ​ເຊີບເວີ​ໃໝ່

ລະຫັດສະຖານະການຕອບສະໜອງ

201 ເພີ່ມ​ປຸ່ມ
400 ຊື່​ທີ່​ຂາດ ຫຼື ກູ​ບ​ສາທາລະນະ​ແມ່ນ​ບໍ່​ເປັນ​ກູ​ບ​ສາທາລະນະ SSH ທີ່​ມີ​ຜົນ​ໄດ້
ຮັບ ລຶບ /api/v1/ssh-keys/{uuid}/

ເອົາ ຫຼື ເອົາອອກ ລະຫັດ 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"

ການ​ບໍາລຸງຮັກສາ ແລະ ຖ່າຍ​ພາບ​ຖ່າຍ

ການ​ສ້າງ​ການ​ບໍາລຸງ​ຮັກສາ ຫຼື ພາບຖ່າຍ​ກໍ​ແມ່ນ​ການ​ປະຕິບັດ​ຂອງ​ເຊີບເວີ: