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
`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 ម៉ាស៊ីនបម្រើ

រាយបញ្ជីម៉ាស៊ីនបម្រើទាំងអស់

ប៉ារ៉ាម៉ែត្រសំណួរ

សំណើឧទាហរណ៍

ឧទាហរណ៍នៃការឆ្លើយតប

លេខកូដស្ថានភាពឆ្លើយតប

បង្កើតម៉ាស៊ីនបម្រើថ្មី

ស្នើសុំប៉ារ៉ាម៉ែត្រតួ

សំណើឧទាហរណ៍

ឧទាហរណ៍នៃការឆ្លើយតប

លេខកូដស្ថានភាពឆ្លើយតប

ទទួលបានព័ត៌មានលម្អិតអំពីម៉ាស៊ីនមេ

ប៉ារ៉ាម៉ែត្រផ្លូវ

សំណើឧទាហរណ៍

ឧទាហរណ៍នៃការឆ្លើយតប

លេខកូដស្ថានភាពឆ្លើយតប

ធ្វើបច្ចុប្បន្នភាពម៉ាស៊ីនមេ

ប៉ារ៉ាម៉ែត្រផ្លូវ

ស្នើសុំប៉ារ៉ាម៉ែត្រតួ

សំណើឧទាហរណ៍

លេខកូដស្ថានភាពឆ្លើយតប

ធ្វើបច្ចុប្បន្នភាពម៉ាស៊ីនមេដោយផ្នែក

សំណើឧទាហរណ៍

លុបម៉ាស៊ីនបម្រើ

សំណើឧទាហរណ៍

លេខកូដស្ថានភាពឆ្លើយតប

ចាប់ផ្តើមម៉ាស៊ីនបម្រើ

សំណើឧទាហរណ៍

ឧទាហរណ៍នៃការឆ្លើយតប

លេខកូដស្ថានភាពឆ្លើយតប

បញ្ឈប់ម៉ាស៊ីនបម្រើ

សំណើឧទាហរណ៍

ឧទាហរណ៍នៃការឆ្លើយតប

ចាប់ផ្ដើមម៉ាស៊ីនមេឡើងវិញ

សំណើឧទាហរណ៍

ឧទាហរណ៍នៃការឆ្លើយតប

លេខកូដស្ថានភាពឆ្លើយតប