VPS.org API

ເອກະສານ REST API

API ສຳຮອງຂໍ້ມູນ

ຈັດການການສຳຮອງຂໍ້ມູນເຊີບເວີໂດຍການຂຽນໂປຣແກຣມ. ລະບຸ, ສ້າງ, ກູ້ຄືນ ແລະ ລຶບການສຳຮອງຂໍ້ມູນສຳລັບເຊີບເວີຂອງທ່ານ.

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

ລາຍຊື່ການສຳຮອງຂໍ້ມູນທັງໝົດ

ດຶງເອົາລາຍຊື່ຂອງການສຳຮອງຂໍ້ມູນທັງໝົດໃນທົ່ວເຊີບເວີຂອງທ່ານ.

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

ພາລາມິເຕີ ປະເພດ ຕ້ອງມີການ ລາຍລະອຽດ
server_id integer ບໍ່ ກັ່ນຕອງການສຳຮອງຂໍ້ມູນຕາມ ID ເຊີບເວີ
backup_type string ບໍ່ ກັ່ນຕອງຕາມປະເພດ: manual , automatic

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

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
params = {"server_id": 12345}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const backups = await response.json();
console.log(backups);

ຕົວຢ່າງການຕອບສະໜອງ

{
  "count": 3,
  "results": [
    {
      "id": 501,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4523,
      "created_at": "2025-01-16T03:00:00Z",
      "expires_at": "2025-02-16T03:00:00Z",
      "description": "Automatic daily backup"
    },
    {
      "id": 499,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "manual",
      "status": "completed",
      "size_mb": 4456,
      "created_at": "2025-01-14T10:30:00Z",
      "expires_at": null,
      "description": "Pre-update backup"
    },
    {
      "id": 495,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4389,
      "created_at": "2025-01-15T03:00:00Z",
      "expires_at": "2025-02-15T03:00:00Z",
      "description": "Automatic daily backup"
    }
  ]
}

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

200 ດຶງຂໍ້ມູນລາຍຊື່ສຳຮອງຂໍ້ມູນສຳເລັດແລ້ວ
401 ບໍ່ໄດ້ຮັບອະນຸຍາດ - ໂທເຄັນການພິສູດຢືນຢັນບໍ່ຖືກຕ້ອງ ຫຼື ບໍ່ມີ
ໂພສ /api/v1/backups/

ສ້າງການສຳຮອງຂໍ້ມູນດ້ວຍຕົນເອງ

ສ້າງການສຳຮອງຂໍ້ມູນດ້ວຍຕົນເອງຂອງເຊີບເວີ. ການສຳຮອງຂໍ້ມູນດ້ວຍຕົນເອງຈະບໍ່ໝົດອາຍຸໂດຍອັດຕະໂນມັດ.

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

ພາລາມິເຕີ ປະເພດ ຕ້ອງມີການ ລາຍລະອຽດ
server_id integer ແມ່ນແລ້ວ ID ຂອງເຊີບເວີເພື່ອສຳຮອງຂໍ້ມູນ
description string ບໍ່ ຄຳອະທິບາຍທາງເລືອກສຳລັບການສຳຮອງຂໍ້ມູນ

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

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "description": "Pre-deployment backup"
  }'
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "description": "Pre-deployment backup"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    description: 'Pre-deployment backup'
  })
});

const backup = await response.json();
console.log(backup);
$data = [
    'server_id' => 12345,
    'description' => 'Pre-deployment backup'
];

$ch = curl_init('https://admin.vps.org/api/v1/backups/');
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);
$backup = json_decode($response, true);
curl_close($ch);

ຕົວຢ່າງການຕອບສະໜອງ

{
  "id": 502,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "backup_type": "manual",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T15:45:00Z",
  "expires_at": null,
  "description": "Pre-deployment backup",
  "message": "Backup is being created. This may take several minutes depending on server size."
}

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

201 ເລີ່ມການສ້າງສຳຮອງຂໍ້ມູນສຳເລັດແລ້ວ
400 ຄຳຮ້ອງຂໍບໍ່ຖືກຕ້ອງ - ພາລາມິເຕີບໍ່ຖືກຕ້ອງ ຫຼື ຄຳຮ້ອງຂໍມີຮູບແບບບໍ່ຖືກຕ້ອງ
401 ບໍ່ໄດ້ຮັບອະນຸຍາດ - ໂທເຄັນການພິສູດຢືນຢັນບໍ່ຖືກຕ້ອງ ຫຼື ບໍ່ມີ
404 ບໍ່ພົບ - ບໍ່ມີເຊີບເວີ
ໝາຍເຫດ: ທ່ານສາມາດມີການສຳຮອງຂໍ້ມູນດ້ວຍຕົນເອງໄດ້ສູງສຸດ 10 ຄັ້ງຕໍ່ເຊີບເວີ. ການສຳຮອງຂໍ້ມູນອັດຕະໂນມັດຈະຖືກເກັບຮັກສາໄວ້ໂດຍອີງຕາມນະໂຍບາຍການເກັບຮັກສາຂໍ້ມູນສຳຮອງຂໍ້ມູນຂອງແຜນການຂອງທ່ານ (ໂດຍປົກກະຕິ 7-30 ມື້).
ລຶບ /api/v1/backups/{backup_id}/

ລຶບຂໍ້ມູນສຳຮອງ

ລຶບຂໍ້ມູນສຳຮອງອອກຢ່າງຖາວອນ. ການກະທຳນີ້ບໍ່ສາມາດຍົກເລີກໄດ້.

ພາລາມິເຕີເສັ້ນທາງ

ພາລາມິເຕີ ປະເພດ ຕ້ອງມີການ ລາຍລະອຽດ
backup_id integer ແມ່ນແລ້ວ ID ສຳຮອງຂໍ້ມູນທີ່ເປັນເອກະລັກ

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

cURL
Python
JavaScript
curl -X DELETE "https://admin.vps.org/api/v1/backups/501/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

backup_id = 501
url = f"https://admin.vps.org/api/v1/backups/{backup_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
const backupId = 501;
const response = await fetch(`https://admin.vps.org/api/v1/backups/${backupId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

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

204 ລຶບຂໍ້ມູນສຳຮອງສຳເລັດແລ້ວ
401 ບໍ່ໄດ້ຮັບອະນຸຍາດ - ໂທເຄັນການພິສູດຢືນຢັນບໍ່ຖືກຕ້ອງ ຫຼື ບໍ່ມີ
404 ບໍ່ພົບ - ບໍ່ມີການສຳຮອງຂໍ້ມູນ
ຄຳເຕືອນ: ການລຶບຂໍ້ມູນສຳຮອງແມ່ນເປັນການລຶບຖາວອນ ແລະ ບໍ່ສາມາດຍົກເລີກໄດ້. ກະລຸນາໃຫ້ແນ່ໃຈວ່າທ່ານບໍ່ຕ້ອງການຂໍ້ມູນສຳຮອງນີ້ອີກຕໍ່ໄປກ່ອນທີ່ຈະລຶບມັນ.

ການກູ້ຄືນຈາກການສຳຮອງຂໍ້ມູນ

ເພື່ອກູ້ຄືນເຊີບເວີຈາກການສຳຮອງຂໍ້ມູນ, ໃຫ້ໃຊ້ຈຸດສິ້ນສຸດການກູ້ຄືນ Servers API :

POST /api/v1/servers/{server_id}/restore/
{
  "backup_id": 501
}

ສຳລັບຂໍ້ມູນລະອຽດກ່ຽວກັບການຟື້ນຟູເຊີບເວີ, ເບິ່ງ ເອກະສານກ່ຽວກັບ API ຂອງເຊີບເວີ.

ວິທີປະຕິບັດທີ່ດີທີ່ສຸດສຳລັບການສຳຮອງຂໍ້ມູນ