VPS.org API

Dokumentasi API REST

API Cadangan

Daftar backup server Anda, mulai backup baru dan kembalikan server dari satu.

Titik akhir 4
Jalur Dasar /api/v1/backups
MENDAPATKAN /api/v1/backups/

Daftar Semua Cadangan

Mengembalikan backup dari semua server Anda, pertama, 25 per halaman. Tidak ada filter server: gunakan server_hostname untuk mengelompokkan mereka.

Perlu izin: backups:list

Parameter Kueri

Parameter Jenis Diperlukan Deskripsi
page integer Tidak Halaman nomor, mulai dari 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 Jawaban

{
  "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"
    }
  ]
}

Kolom Respons

Ruas Jenis Deskripsi
id integer Pengenal cadangan, yang digunakan oleh titik-titik dapatkan dan restore
server_hostname string Nama host server yang backup diambil dari
name string Nama berkas arsip cadangan
size_gb number Ukuran terkompresi dalam gigabytes
deletion_date datetime Ketika backup akan dihapus secara otomatis
days_remaining integer Seluruh hari tersisa sampai penghapusan_date
created_at datetime Waktu Penciptaan (ISO 8601, UTC)

Kode Status Respons

200 Berhasil mengambil daftar cadangan
403 Hilang atau token API tak valid, atau token kurang izin yang diperlukan
MENDAPATKAN /api/v1/backups/{id}/

Dapatkan Bantuan

Mengembalikan satu objek cadangan dengan ruas 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/

Buat Backup

Mengantre cadangan server yang dikerahkan. Tidak ada permintaan tubuh yang diperlukan. Backup muncul dalam daftar setelah selesai, yang dapat memakan waktu beberapa menit tergantung pada penggunaan disk.

Perlu izin: 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 Jawaban

{
  "message": "Backup queued successfully"
}

Kode Status Respons

200 Aksi diantrikan
400 Server belum diterjunkan
402 Tidak ada metode pembayaran pada berkas, atau faktur yang belum dibayar
404 Tidak ditemukan, atau milik akun lain
POST /api/v1/backups/{id}/restore/

Mengembalikan Server dari Backup

Menghentikan server yang backup diambil dari, menimpa disknya dengan backup dan memulainya lagi. Tidak ada badan permintaan yang diperlukan. Status server antrian saat restore runs.

Perlu izin: 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"
}
Peringatan: Semua yang ditulis ke server setelah backup diambil hilang. Pemulihan tidak dapat dibatalkan.

Kode Status Respons

200 Aksi diantrikan
400 Server belum diterjunkan
404 Tidak ditemukan, atau milik akun lain

Catatan