VPS API, otomatisasi server cloud dengan JSON REST
API server cloud untuk mengelola server dengan kode, dari pembuatan hingga penghapusan
- JSON REST API
- Autentikasi API key (Bearer)
- 300 permintaan per menit
VPS API adalah cara terprogram untuk melakukan pekerjaan yang biasanya dilakukan di panel kontrol, seperti membuat, memulai, menghentikan, dan menghapus server, dengan permintaan HTTP. API server cloud HELPER VPS gratis untuk semua member; setelah pembayaran pertama Anda, buat API key dan langsung hubungkan.
REST API
Semua member
Gratis
Ditagih bulanan
- JSON REST
- API key (Bearer)
- 300 per menit
- Gratis
Untuk langsung melihat contoh permintaan dan format respons Dokumentasi API
Apa yang bisa diotomatisasi dengan VPS API?
VPS API paling bermanfaat saat Anda sering membuat dan menghapus server, atau mengelola banyak server sekaligus. Berikut empat otomatisasi yang paling sering dipakai.
Membuat server di pipeline deploy
Di pipeline deploy seperti GitLab CI, buat server uji dengan permintaan POST /servers, lalu hapus dengan permintaan DELETE setelah pengujian selesai. Server hanya ada saat dibutuhkan sehingga biaya tetap rapi.
Cek status server dan pengaturan daya
Baca daftar server, status, alamat IPv4 dan IPv6, serta tanggal tagihan berikutnya dengan GET /servers, lalu atur daya dengan permintaan start, stop, dan reboot bila perlu. Hubungkan dengan tool monitoring untuk membuat skrip yang me-restart server yang berhenti.
Menjual dan mengelola server di dalam layanan Anda
Panggil API dari panel admin atau bot buatan sendiri untuk membuat server dan menampilkan hasilnya. Baca daftar produk GET /catalog untuk menampilkan ukuran, lokasi, sistem operasi, dan opsi yang bisa dipilih apa adanya di layar.
Pengelolaan tanggal tagihan dan perpanjangan
Periksa tanggal penagihan berikutnya setiap server dengan nilai paid_until, dan langsung perpanjang dengan permintaan renew untuk server yang ingin Anda bayar untuk periode lebih panjang. Lacak invoice dan tanggal penagihan Anda dalam kode untuk menjaga server penting tetap berjalan dengan stabil.
Panel kontrol atau VPS API, kapan memakai yang mana?
Panel kontrol dan API bekerja dengan akun dan server yang sama. Untuk mengelola satu atau dua server secara manual, panel kontrol lebih nyaman; untuk pekerjaan berulang atau banyak server, API lebih cepat.
Panel kontrol
Cara mengelola dengan klik di layar
Cocok untuk
- Saat pertama kali membuat server
- Saat mengelola sendiri satu atau dua server
- Instal ulang sistem operasi dan menambahkan SSH key
- Saat melihat lagi password root
VPS API
Cara mengelola dengan permintaan lewat kode
Cocok untuk
- Lingkungan uji yang sering membuat dan menghapus server
- Otomatisasi pipeline deploy dan skrip
- Saat membaca status banyak server sekaligus
- Saat menghubungkan dengan panel admin atau bot buatan sendiri
Bagaimana cara menghubungkan API server cloud?
Ada tiga langkah. Pertama, lakukan pembayaran pertama Anda, dan setelah dikonfirmasi, buat key di halaman API key. Selanjutnya, masukkan key ke header Authorization setiap permintaan menggunakan skema Bearer. Terakhir, kirim permintaan ke path yang Anda inginkan setelah alamat dasar https://helpervps.com/api/v1, dan hasilnya kembali sebagai JSON.
Di awal, sebaiknya panggil GET /catalog. Jenis dan ukuran server yang bisa dipilih saat ini, kode lokasi, kode sistem operasi dan aplikasi sekali klik, serta harga backup otomatis, disk tambahan, dan perlindungan DDoS dikembalikan sekaligus. Masukkan kode plan, location, dan image yang diterima dari sini apa adanya ke permintaan pembuatan server.
Untuk membuat server, kirim nilai plan, location, image, dan label sebagai JSON ke POST /servers. Anda juga bisa menyertakan ID SSH key yang telah ditambahkan dan opsi backups, extra_disk_gb, dan ddos_protection. Anda membayar untuk periode yang dipilih di muka, dan respons berisi ID server, status, dan password root, jadi simpan di tempat aman segera.
Pekerjaan apa saja yang bisa dilakukan dengan VPS API?
VPS API menangani siklus hidup server dari awal hingga akhir. Baca daftar produk dengan GET /catalog, buat server dengan POST /servers, baca daftar server Anda dengan GET /servers, dan info satu server dengan GET /servers/{id}. Respons berisi nama server, status, alamat IPv4 dan IPv6, tarif bulanan, opsi yang dipilih, dan tanggal tagihan berikutnya.
Daya dinyalakan, dimatikan, dan di-restart dengan permintaan POST /servers/{id}/start, stop, dan reboot. POST /servers/{id}/renew membayar biaya satu bulan sekarang untuk langsung memperpanjang tanpa menunggu tanggal tagihan, dan DELETE /servers/{id} menghapus server. Jika permintaan tidak sesuai status server saat ini, kode wrong_state dikembalikan sehingga skrip mudah menentukan langkah berikutnya.
Error dikembalikan sebagai JSON berisi nilai error bersama kode status. Alasannya dibedakan dengan kode, seperti unauthorized jika key salah, not_enough_balance jika saldo kurang, limit jika jumlah server akun sudah mencapai batas, dan rate_limited jika permintaan terlalu banyak, sehingga mudah ditangani per situasi di program. Daftar lengkap dan contoh respons ada di dokumentasi API.
Berapa biaya VPS API?
VPS API gratis untuk semua member. Server dan opsi yang dibuat dengan API dibayar dengan harga yang sama seperti server yang dibuat di panel kontrol.
Pemakaian API gratis
Tidak ada biaya untuk menerbitkan API key atau membuat permintaan. Member yang telah melakukan pembayaran pertama dapat membuat key dan langsung menggunakannya.
300 permintaan per menit
Satu key bisa mengirim hingga 300 permintaan per menit. Batas yang lega untuk otomatisasi sehari hari seperti cek daftar server dan pengaturan daya.
Harga sama dengan panel kontrol
Server yang dibuat dengan API memiliki harga yang sama seperti daftar harga, opsi ditambahkan dengan jumlah yang sama, dan diperpanjang pada setiap tanggal penagihan.
HELPER VPS dalam angka
Pilih dari 40 wilayah, 12 sistem operasi, dan 10 aplikasi sekali klik dalam satu akun, dan bayar langsung. Angka di bawah berdasarkan produk yang dijual saat ini.
40
Lokasi data center
12
Sistem operasi
10
Aplikasi sekali klik
Gratis
Harga mulai produk ini (bulanan)
Tool otomatisasi yang dipakai bersama VPS API
Tool apa pun yang bisa mengirim permintaan HTTP bisa terhubung ke VPS API. Dari satu baris curl hingga skrip Python, Node.js, dan pipeline deploy, semua dipakai dengan cara yang sama.
- Terraform
- Python
- Node.js
- GitLab CI
- Docker
Alasan memilih API HELPER VPS
JSON REST yang sederhana
Kirim permintaan dan terima respons dengan metode HTTP dan JSON yang familiar. Bisa langsung diuji dengan curl tanpa library tambahan.
Autentikasi API key (Bearer)
Cukup memasukkan satu key di header Authorization, jadi autentikasinya sama di bahasa dan tool apa pun.
300 permintaan per menit
Satu key bisa mengirim hingga 300 permintaan per menit, jadi cek status dan pengaturan daya banyak server ditangani dengan lega.
Daftar produk lewat kode
Baca ukuran, lokasi, sistem operasi, dan harga opsi dengan GET /catalog lalu pakai apa adanya di tampilan dan skrip Anda.
Dari pembuatan hingga penghapusan
Pembuatan server, daftar, menyalakan, mematikan, restart, perpanjangan, dan penghapusan semuanya diproses lewat API.
Pilih opsi sekaligus
Saat membuat server, masukkan backup otomatis, disk tambahan, perlindungan DDoS, dan SSH key dalam satu permintaan.
Kode error yang menunjukkan alasannya
Alasan error dibagi menjadi kode, seperti saldo akun tidak cukup, batas server, dan ketidakcocokan status, sehingga mudah ditangani dalam program Anda.
Akun yang sama dengan panel kontrol
Server yang dibuat dengan API muncul di panel kontrol apa adanya, dan dibayar serta diperpanjang dengan cara yang sama.
Gratis untuk semua member
Setelah Anda melakukan pembayaran pertama, buat API key tanpa biaya dan langsung mulai otomatisasi.
Pertanyaan umum VPS API
Jawaban tentang koneksi, autentikasi, dan batas permintaan VPS API
Apakah VPS API gratis?
Ya, VPS API gratis untuk semua member. Penerbitan API key dan membuat permintaan gratis, dan server serta opsi yang dibuat dengan API dibayar dengan harga yang sama seperti yang dibuat di panel kontrol. Member yang telah melakukan pembayaran pertama dapat langsung membuat key di halaman API key.
Di mana membuat API key?
Setelah Anda melakukan pembayaran pertama, halaman API key (/api-key) terbuka dan Anda membuat key di sana. Masukkan key ke header Authorization setiap permintaan menggunakan skema Bearer. Key membuka seluruh akun Anda, jadi jangan simpan di repositori kode; simpan di environment variable atau penyimpanan rahasia.
Pekerjaan apa saja yang bisa dilakukan dengan API?
Anda bisa membaca daftar produk (GET /catalog), membaca daftar server dan info satu server (GET /servers, GET /servers/{id}), membuat server (POST /servers), menyalakan, mematikan, dan restart (start, stop, reboot), memperpanjang sebulan (renew), dan menghapus (DELETE /servers/{id}). Contoh permintaan dan format respons ada di dokumentasi API.
Berapa batas permintaannya?
Satu key bisa mengirim hingga 300 permintaan per menit. Jika melewati batas, status code 429 dan error rate_limited dikembalikan, jadi cukup atur skrip agar menunggu sebentar lalu mengirim ulang. Otomatisasi sehari hari seperti cek daftar server dan pengaturan daya berjalan lega dalam batas ini. Tidak ada biaya berdasarkan jumlah permintaan.
Jika membuat server lewat API, bagaimana biayanya dipotong?
Ketika permintaan POST /servers berhasil, pembayaran untuk periode penagihan yang Anda pilih diproses dan server dibuat. Pembayaran untuk server yang gagal dibuat dikembalikan ke saldo akun Anda.
Bagaimana menerima password root lewat API?
Respons permintaan pembuatan server berisi nilai root_password satu kali. Simpan segera di tempat aman begitu respons diterima. Password juga bisa dilihat lagi di panel kontrol selama 7 hari, dan jika nomor SSH key ikut dikirim, Anda langsung login dengan key tanpa password. Dengan nilai ipv4 di respons, akses SSH bisa langsung dimulai, cocok untuk dihubungkan ke skrip deploy.
Bisakah SSH key dimasukkan lewat API?
Ya, masukkan nomor SSH key yang sudah ditambahkan sebagai nilai ssh_key_id di permintaan pembuatan server, maka key itu masuk ke server baru. Cukup tambahkan key sekali di halaman SSH key panel kontrol, dan fingerprint ditampilkan dengan cara yang sama seperti ssh-keygen sehingga langsung terlihat key mana. Tentukan nomor key sekali lalu pakai ulang.
Bahasa atau tool apa yang bisa dipakai?
Bahasa dan tool apa pun bisa, asalkan bisa mengirim permintaan HTTP. Uji langsung dengan curl, lalu panggil dengan alamat dan header yang sama dari requests di Python, fetch di Node.js, langkah skrip GitLab CI, atau fitur permintaan HTTP di Terraform. Semua respons dalam JSON sehingga hasilnya mudah dibaca.
Bagaimana mengetahui jika terjadi error?
Error dikembalikan sebagai JSON berisi nilai error bersama status code selain 2xx. Alasannya dibedakan, seperti unauthorized jika key salah, bad_request jika ada nilai yang kurang, not_enough_balance jika saldo kurang, dan wrong_state jika permintaan tidak sesuai status server, sehingga program bisa menangani per situasi.
Apakah server yang dibuat lewat API juga tampil di panel kontrol?
Ya, API dan panel kontrol menangani akun dan server yang sama. Server yang dibuat lewat API tampil apa adanya di daftar panel kontrol, dan Anda bisa menginstal ulang sistem operasi atau melihat password di panel kontrol. Batas 10 server per akun juga berlaku untuk kedua cara. Meski pekerjaan manual dan lewat kode dicampur, status dan tanggal tagihan selalu terlihat sama.
Panduan VPS API
Panduan yang bagus dibaca saat pertama kali menghubungkan API
- Dokumentasi APIAlamat dasar, header autentikasi, contoh permintaan per path dan format respons, serta daftar lengkap kode error.
- Membuat dan menambahkan SSH keyCara membuat dan menambahkan SSH key agar langsung login dengan key ke server yang dibuat lewat API.
- Lihat tarif sekilasBandingkan tarif bulanan ukuran server dan opsi yang bisa dipilih lewat API di satu halaman.
VPS API gratis untuk semua member, dan Anda dapat membuat API key setelah melakukan pembayaran pertama. Server dan opsi yang dibuat dengan API dibayar dengan harga yang sama seperti daftar harga dan diperpanjang secara otomatis dengan jumlah yang sama pada setiap tanggal penagihan.
Batas permintaan: 300 per menit per API key | 10 server per akun | Jika pembayaran gagal: server ditangguhkan, lalu dihapus 3 hari kemudian | Sisa waktu pada server yang dihapus tidak dikembalikan. Pengembalian dana dikembalikan ke saldo akun Anda.
