Dokumentasi API VPS: REST API untuk mencipta dan mengurus pelayan

Apa yang boleh dilakukan dengan API

API sesuai apabila anda mengurus banyak pelayan atau ingin mengautomasikan penyebaran. Muat turun senarai pelan, rantau dan imej; apabila anda mencipta pelayan, pembayaran diproses dan pelayan anda dicipta selepas pengesahan. Peraturan yang sama seperti laman web terpakai, jadi pelayan yang dicipta dengan API juga muncul dalam senarai pelayan akaun anda.

Jika baru pertama kali, ikuti panduan mula pantas API mengikut urutan daripada mencipta kunci hingga mencipta pelayan pertama. Halaman ini ialah dokumen rujukan yang menghimpunkan semua endpoint dan medan di satu tempat.

Alamat asas

Semua permintaan dihantar dengan menambah laluan di belakang alamat di bawah. Badan permintaan dan respons semuanya JSON (UTF-8).

https://helpervps.com/api/v1

Pengesahan

Hantar header Authorization: Bearer YOUR_API_KEY. Anda boleh mencipta kunci dari menu kunci API dalam akaun anda selepas pembayaran pertama; kunci bermula dengan hvp_. Kunci penuh dipaparkan hanya sekali, sejurus selepas ia dicipta, dan mencipta kunci baharu akan melumpuhkan kunci lama dengan serta-merta.

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Had permintaan

Kod pelayan

Pelayan dibezakan bukan dengan nombor urutan, tetapi dengan kod pelayan seperti S-7K2M-9QX4-HB3T. Masukkan nilai id daripada senarai pelayan atau respons penciptaan terus ke dalam laluan. Huruf besar dan kecil tidak dibezakan.

GET /catalog

Mengembalikan spesifikasi (plans), lokasi (locations), imej (images) dan pilihan tambahan (addons) yang dijual sekali gus. Semua kod yang digunakan semasa mencipta pelayan datang dari sini. monthly ialah kadar bulanan dalam dolar AS, dan pilihan yang tidak dijual dihantar sebagai null. monthly_per_gb bagi cakera tambahan dipaparkan hingga tiga tempat perpuluhan.

Contoh permintaan

curl https://helpervps.com/api/v1/catalog \
  -H "Authorization: Bearer YOUR_API_KEY"

Contoh respons

{
  "plans": [
    { "code": "s2", "type": "basic", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "transfer_tb": 2, "monthly": "2.48" }
  ],
  "locations": ["frankfurt", "singapore", "seoul"],
  "images": ["ubuntu-24-04", "debian-13", "almalinux-10", "app-docker"],
  "addons": {
    "backups": { "percent_of_plan": 5.6 },
    "extra_disk": { "sizes_gb": [50, 100, 250, 500, 1000], "monthly_per_gb": "0.028" },
    "ddos_protection": { "monthly": "1.68" }
  }
}

GET /servers

Mengembalikan senarai pelayan anda mengikut urutan terkini dicipta. Pelayan yang telah dipadam atau gagal dicipta tidak disertakan.

Contoh permintaan

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Contoh respons

[
  {
    "id": "S-7K2M-9QX4-HB3T",
    "label": "web-1",
    "state": "running",
    "ipv4": "192.0.2.15",
    "ipv6": "2001:db8::15",
    "monthly": "2.48",
    "backups": false,
    "extra_disk_gb": 0,
    "ddos_protection": false,
    "paid_until": "2026-11-18T09:00:00.000Z"
  }
]

POST /servers

Mencipta pelayan dan memproses pembayaran. Gunakan kod katalog untuk pelan, lokasi dan imej seperti sedia ada. label menerima sehingga 40 huruf Latin, nombor, titik dan sempang; aksara lain ditukar kepada sempang. backups, extra_disk_gb dan ddos_protection adalah pilihan. Jika berjaya, anda menerima 201 dengan butiran pelayan, dan root_password disertakan sekali dalam respons ini (anda juga boleh melihatnya di halaman pelayan dalam akaun anda selama 7 hari).

Contoh permintaan

curl -X POST https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1","backups":true,"extra_disk_gb":0,"ddos_protection":false}'

Contoh respons

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "creating",
  "ipv4": null,
  "ipv6": null,
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z",
  "root_password": "..."
}

GET /servers/{id}

Mengembalikan status, alamat, kadar bulanan dan tarikh tamat bayaran bagi satu pelayan. Pelayan baharu bermula dengan creating, menjadi running apabila siap, dan ipv4 serta ipv6 diisi. Menyemak setiap beberapa saat sudah memadai.

Contoh permintaan

curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Contoh respons

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "running",
  "ipv4": "192.0.2.15",
  "ipv6": "2001:db8::15",
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z"
}

POST /servers/{id}/start (stop, reboot)

start menghidupkan pelayan yang berhenti (stopped), manakala stop dan reboot mematikan atau memulakan semula pelayan yang sedang berjalan (running). Respons ialah maklumat pelayan yang telah berubah.

Contoh permintaan

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \
  -H "Authorization: Bearer YOUR_API_KEY"

Contoh respons

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "rebooting",
  ...
}

POST /servers/{id}/renew

Bayar sekarang untuk melanjutkan tempoh sah. Pelayan yang digantung selepas tamat tempoh juga akan hidup semula dengan permintaan ini.

Contoh permintaan

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \
  -H "Authorization: Bearer YOUR_API_KEY"

Contoh respons

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "running",
  "paid_until": "2026-12-18T09:00:00.000Z",
  ...
}

DELETE /servers/{id}

Memadam pelayan dan cakeranya. Caj tidak dikenakan mulai tarikh bil seterusnya, dan baki tempoh bulan yang telah dibayar tidak dibayar balik.

Contoh permintaan

curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Contoh respons

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "deleted"
}

Medan respons pelayan

Nilai status

Ralat

Jika berlaku ralat, JSON berbentuk {"error": "kod"} dikembalikan bersama kod status. Bezakan pengendalian berdasarkan nilai kod tersebut.

Panduan berkaitan

Pembayaran dibuat melalui pembayaran selamat PayGate. Anda boleh memasang semula dan mencipta kata laluan root baharu di halaman pelayan dalam akaun anda; langkah-langkahnya ada dalam panduan pasang semula.

Perkara yang boleh dilakukan dengan API dan contoh automasi ada di halaman VPS API, dan kadar bulanan mengikut spesifikasi ada di halaman harga.