VPS.org API

Dokumentasi API REST

API Cuplikan

Ambil snapshot label dari server, daftarkan dan hapus yang tidak lagi Anda butuhkan.

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

Daftar Semua Cuplikan

Mengembalikan foto-foto dalam akun Anda, terbaru pertama, 25 per halaman.

Perlu izin: snapshots:list

Contoh Permintaan

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

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

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

Contoh Jawaban

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

Kolom Respons

Ruas Jenis Deskripsi
uuid string Pengenal snapshot (32 karakter heksadesimal, tanpa tanda hubung)
label string Label diberikan ketika snapshot dibuat
server_hostname string Nama host server foto diambil dari, atau kosongkan jika server tersebut tidak ada lagi
ready boolean Benar sekali snapshot telah selesai
deleting boolean Benar sementara penghapusan sedang berlangsung
created_at datetime Waktu Penciptaan (ISO 8601, UTC)
size_gb number Ukuran terkompresi dalam gigabytes
MENDAPATKAN /api/v1/snapshots/{uuid}/

Ambil Snapshot

Mengembalikan satu objek snapshot dengan ruas di atas. Gunakan itu untuk penjajakan siap setelah membuat snapshot.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/snapshot/

Buat Snapshot

Antrikan snapshot dari server yang diterjunkan dan kembalikan uuid snapshot baru. Snapshot terdaftar langsung dengan set ke false.

Perlu izin: servers:snapshot

Parameter Badan Permintaan

Parameter Jenis Diperlukan Deskripsi
action string Ya Harus snapshot
snapshot_label string Ya Label untuk mengenali snapshot ini dengan
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

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

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

Contoh Jawaban

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

Kode Status Respons

200 Aksi diantrikan
400 aksi atau snapshot_label hilang, atau server belum dispensiunkan
402 Tidak ada metode pembayaran pada berkas, atau faktur yang belum dibayar
404 Tidak ditemukan, atau milik akun lain
MENGHAPUS /api/v1/snapshots/{uuid}/

Hapus Snapshot

Antrian snapshot untuk penghapusan permanen. Menghapus benar sampai hilang.

Perlu izin: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

Kode Status Respons

202 Diterima: permintaan diantre
404 Tidak ditemukan, atau milik akun lain

Catatan