VPS.org API

Dokumentasi API REST

VPS.org API Documentation

Dokumentasi API REST lengkap untuk mengelola server VPS, domain, DNS, pencadangan, dan banyak lagi.

URL Dasar https://admin.vps.org/api/v1
Autentikasi Token Pembawa
Versi v1
Format JSON

Memulai

API VPS.org memungkinkan Anda untuk mengelola semua aspek infrastruktur hosting VPS Anda secara terprogram, termasuk server, domain, catatan DNS, cadangan, dan snapshot.

Autentikasi

Semua permintaan API memerlukan autentikasi menggunakan token Bearer. Anda dapat membuat token API Anda dari pengaturan akun Anda di admin.vps.org/account/developers/.

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

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

Setiap token membawa izin sendiri, seperti server:list atau dns:*. Permintaan yang membutuhkan izin token tidak memiliki ditolak dengan 403 dan sebuah daerah wajib_permisi yang menyebutkan izin yang hilang. Referensi Ijin

Pembatasan Laju

Permintaan yang otentik terbatas pada 1.000 per jam per akun. Permintaan yang tidak terotentikasi terbatas pada 100 per jam per alamat IP. Permintaan atas batas menerima 429 dengan header Retry- After memberikan jumlah detik untuk menunggu. Tak ada batas kecepatan tajuk yang dikirim pada respon sukses.

Penggabungan

Daftar titik akhir mengembalikan objek dengan jumlah, selanjutnya, hasil, 25 butir per halaman. Halaman yang dilewatkan untuk dipindahkan antar halaman, atau ikuti URL berikutnya sampai kosong. Daftar server juga menerima halaman_ukuran, hingga 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Penanganan Kesalahan

API ini menggunakan kode status HTTP standar untuk menunjukkan keberhasilan atau kegagalan:

Kode Status Deskripsi
200 Berhasil - Permintaan berhasil diselesaikan
201 Dibuat - Sumber daya berhasil dibuat
400 Permintaan Buruk - Parameter tidak valid atau permintaan yang salah format
202, 204 Menerima dan antrian (202), atau dihapus tanpa respon body (204)
402 Pembayaran Diperlukan: tidak ada metode pembayaran pada berkas, faktur tidak dibayar, atau kartu ditolak pra- otorisasi
403 Dilarang: tokennya hilang, tidak valid atau kadaluarsa, atau kurang izin yang diperlukan. Otentikasi gagal juga mengembalikan 403, bukan 401.
404 Tidak Ditemukan - Sumber daya tidak ada
409 Konflik: misalnya telah mengubah ukuran dalam proses, tidak cukup kapasitas, atau penyebaran yang sudah berjalan
429 Terlalu Banyak Permintaan - Batas permintaan terlampaui
500 Kesalahan Server Internal - Terjadi kesalahan di pihak kami
503 Layanan Tidak Tersedia: masalah sementara. Coba lagi, menghormati Coba-Setelah dikirim.

Mayat galat adalah JSON. Kebanyakan memiliki ruas detail atau ruas galat, kadang-kadang dengan pesan; kesalahan validasi daftar masalah dengan nama field.

Kategori API

Telusuri dokumentasi API kami berdasarkan kategori:

API Server 15 Titik akhir

Buat, periksa, daya, ubah ukuran dan hapus server, reset sandi root, set mundur DNS, jalankan perintah, dan atur tombol SSH.

Lihat Dokumentasi
API Cadangan 4 Titik akhir

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

Lihat Dokumentasi
API Cuplikan 4 Titik akhir

Ambil snapshot label dari server, daftar mereka dan hapus.

Lihat Dokumentasi
API Paket 2 Titik akhir

Temukan paket VPS dan informasi harga yang tersedia. Dapatkan detail tentang sumber daya, harga, dan ketersediaan.

Lihat Dokumentasi
API Sistem Operasi 2 Titik akhir

Daftar sistem operasi dan versi yang dapat Anda pasang, seperti Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora dan Alpine.

Lihat Dokumentasi
API Domain 7 Titik akhir

Periksa ketersediaan, register dan domain terbarukan, dan set nameserver dan auto-renegal.

Lihat Dokumentasi
API DNS 13 Titik akhir

Buat zona DNS dan buat, perbarui dan hapus AAA, CNAME, MX, TXT, SRV, CAA, dan catatan lainnya.

Lihat Dokumentasi
API Lokasi 2 Titik akhir

Tampilkan lokasi yang tersedia untuk penyebaran server.

Lihat Dokumentasi
Akun 1 Titik akhir

Ambil profil akun dan informasi token API. Kenali token akun mana yang dimiliki dan periksa izinnya.

Lihat Dokumentasi
Affiliates 7 Titik akhir

Tarik keseimbangan afiliasi, rujukan, komisi dan pembayaran ke pelaporan Anda sendiri, ubah pengaturan pembayaran dan permintaan pembayaran.

Lihat Dokumentasi

Titik Akhir Lebih

API juga memiliki titik akhir untuk penyebaran aplikasi (/api/v1/deploy-configs/ dan /api/v1/deployments/). Mereka tidak dijelaskan di halaman-halaman ini namun; daftar referensi interaktif setiap titik akhir, dihasilkan dari API hidup.

Buka referensi API interaktif

Butuh Bantuan?

Jika Anda memiliki pertanyaan atau memerlukan bantuan terkait API, jangan ragu untuk menghubungi kami: