VPS.org API

Dokumentasi API REST

API Sandaran

Senarai sandaran pelayan anda, mulakan sandaran baru dan pulihkan pelayan dari satu.

Titik akhir 4
Laluan Asas /api/v1/backups
DAPATKAN /api/v1/backups/

Senaraikan Semua Sandaran

Kembalikan sandaran semua pelayan anda, terkini pertama, 25 per halaman. Tiada penapis pelayan: guna nama_hos_pelayan untuk mengumpulannya.

Keizinan diperlukan: backups:list

Parameter Pertanyaan

Parameter Jenis Diperlukan Huraian
page integer Tidak Nombor halaman, bermula pada 1

Contoh Permintaan

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Contoh Respons

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

Medan Respons

Medan Jenis Huraian
id integer Pengenalpasti sandaran, digunakan oleh titik akhir dapatkan dan pulihkan
server_hostname string Nama hos pelayan yang sandaran diambil daripada
name string Nama fail arkib sandaran
size_gb number Saiz dimampat dalam gigabyte
deletion_date datetime Bila sandaran akan dibuang secara automatik
days_remaining integer Hari penuh yang tinggal sehingga tarikh_pembersihan
created_at datetime Masa penciptaan (ISO 8601, UTC)

Kod Status Respons

200 Senarai sandaran berjaya diperoleh
403 Token API hilang atau tidak sah, atau token tidak mempunyai keizinan yang diperlukan
DAPATKAN /api/v1/backups/{id}/

Dapatkan Sandaran

Kembalikan satu objek sandaran dengan medan di atas.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/backup/

Cipta Sandaran

Berijilun sandaran pelayan yang dilaksanakan. Tiada badan permintaan diperlukan. Sandaran muncul dalam senarai apabila ia selesai, yang boleh mengambil beberapa minit bergantung pada penggunaan cakera.

Keizinan diperlukan: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

Contoh Respons

{
  "message": "Backup queued successfully"
}

Kod Status Respons

200 Tindakan telah diibalkan
400 Pelayan belum dilaksanakan
402 Tiada kaedah pembayaran pada fail, atau bil tidak dibayar
404 Tidak dijumpai, atau ia milik akaun lain
POST /api/v1/backups/{id}/restore/

Pulihkan Pelayan dari Sandaran

Hentikan pelayan yang sandar diambil daripada, tulis ganti cakera dengan sandar dan mulakan semula. Tiada badan permintaan diperlukan. Status pelayan adalah baris gilir semasa pemulihan berjalan.

Keizinan diperlukan: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
Amaran: Semua yang ditulis ke pelayan selepas sandaran diambil akan hilang. Pulihkan tidak boleh ditunda.

Kod Status Respons

200 Tindakan telah diibalkan
400 Pelayan belum dilaksanakan
404 Tidak dijumpai, atau ia milik akaun lain

Nota