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 เซิร์ฟเวอร์

แสดงรายชื่อเซิร์ฟเวอร์ทั้งหมด

พารามิเตอร์การค้นหา

ตัวอย่างคำขอ

ตัวอย่างคำตอบ

รหัสสถานะการตอบกลับ

สร้างเซิร์ฟเวอร์ใหม่

พารามิเตอร์เนื้อหาคำขอ

ตัวอย่างคำขอ

ตัวอย่างคำตอบ

รหัสสถานะการตอบกลับ

ดูรายละเอียดเซิร์ฟเวอร์

พารามิเตอร์เส้นทาง

ตัวอย่างคำขอ

ตัวอย่างคำตอบ

รหัสสถานะการตอบกลับ

เซิร์ฟเวอร์อัปเดต

พารามิเตอร์เส้นทาง

พารามิเตอร์เนื้อหาคำขอ

ตัวอย่างคำขอ

รหัสสถานะการตอบกลับ

อัปเดตเซิร์ฟเวอร์บางส่วน

ตัวอย่างคำขอ

ลบเซิร์ฟเวอร์

ตัวอย่างคำขอ

รหัสสถานะการตอบกลับ

เริ่มเซิร์ฟเวอร์

ตัวอย่างคำขอ

ตัวอย่างคำตอบ

รหัสสถานะการตอบกลับ

หยุดเซิร์ฟเวอร์

ตัวอย่างคำขอ

ตัวอย่างคำตอบ

รีบูตเซิร์ฟเวอร์

ตัวอย่างคำขอ

ตัวอย่างคำตอบ

รหัสสถานะการตอบกลับ