VPS.org API

Dokumentasi API REST

Dokumentasi API VPS.org

Dokumentasi API REST yang lengkap untuk mengurus pelayan VPS, domain, DNS, sandaran dan banyak lagi.

URL Asas https://admin.vps.org/api/v1
Pengesahan Token Pembawa
Versi v1
Format JSON

Bermula

API VPS.org membolehkan anda mengurus semua aspek infrastruktur pengehosan VPS anda secara pengaturcaraan, termasuk pelayan, domain, rekod DNS, sandaran dan snapshot.

Pengesahan

Semua permintaan API memerlukan pengesahan menggunakan token Bearer. Anda boleh menjana token API anda daripada tetapan akaun 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 keizinan sendiri, seperti servers:list atau dns:*. Permintaan yang memerlukan keizinan yang token tidak ada ditolak dengan 403 dan medan required_permission yang menamakan keizinan yang hilang. Rujukan Keizinan

Had Kadar

Permintaan yang disahkan sah terhad kepada 1,000 per jam bagi setiap akaun. Permintaan yang tidak disahkan sah terhad kepada 100 per jam bagi setiap alamat IP. Permintaan melebihi had menerima 429 dengan pengepala Cuba-Seterusnya memberikan bilangan saat untuk menunggu. Tiada pengepala had kadar dihantar pada maklum balas yang berjaya.

Penghantaran

Titik akhir senarai mengembalikan objek dengan kiraan, seterusnya, terdahulu dan hasil, 25 item per halaman. Lalukan halaman untuk bergerak antara halaman, atau ikut URL seterusnya sehingga ia adalah null. Senarai pelayan juga menerima page_size, sehingga 100.

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

Pengendalian Ralat

API menggunakan kod status HTTP standard untuk menunjukkan kejayaan atau kegagalan:

Kod Status Huraian
200 Kejayaan - Permintaan berjaya diselesaikan
201 Dicipta - Sumber berjaya dicipta
400 Permintaan Buruk - Parameter tidak sah atau permintaan salah bentuk
202, 204 Terima dan diulitkan (202), atau dipadam tanpa badan maklum balas (204)
402 Pembayaran Diperlukan: tiada kaedah pembayaran pada fail, bil tidak dibayar, atau pra-pengesahan kad ditolak
403 Dilarang: token hilang, tidak sah atau tamat tempoh, atau tiada keizinan yang diperlukan. Pengesahan gagal juga mengembalikan 403, bukan 401.
404 Tidak Dijumpai - Sumber tidak wujud
409 Konflik: contohnya saiz semula yang sedang dilaksanakan, tidak cukup kapasiti, atau pelaksanaan yang sedang berjalan
429 Terlalu Banyak Permintaan - Had kadar telah dilampaui
500 Ralat Pelayan Dalaman - Sesuatu yang tidak kena telah berlaku di pihak kami
503 Servis Tidak Ada: masalah sementara. Cuba lagi, menghormati Retry-After bila ia dihantar.

Badan ralat adalah JSON. Kebanyakan mempunyai medan perincian atau medan ralat, kadang-kadang dengan mesej; ralat pengesahan menyenaraikan masalah mengikut nama medan.

Kategori API

Layari dokumentasi API kami mengikut kategori:

API Pelayan 15 Titik akhir

Cipta, periksa, kuasa, saiz semula dan padam pelayan, set semula katalaluan root, tetap DNS terbalik, jalankan perintah, dan urus kunci SSH.

Lihat Dokumentasi
API Sandaran 4 Titik akhir

Senarai sandaran pelayan anda, mulakan sandaran baru, dan pulihkan pelayan dari sandaran.

Lihat Dokumentasi
API Gambaran Ringkas 4 Titik akhir

Ambil snapshot berlabel pelayan, daftar dan padam mereka.

Lihat Dokumentasi
API Pelan 2 Titik akhir

Dapatkan pelan VPS dan maklumat harga yang tersedia. Dapatkan butiran tentang sumber, harga dan ketersediaan.

Lihat Dokumentasi
API Sistem Pengendalian 2 Titik akhir

Senarai sistem operasi dan versi yang boleh dipasang, seperti Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora dan Alpine.

Lihat Dokumentasi
Domain API 7 Titik akhir

Semak ketersediaan, daftar dan ulang domain, dan tetapkan pelayan nama dan auto-ulang.

Lihat Dokumentasi
API DNS 13 Titik akhir

Cipta zon DNS dan cipta, kemaskini dan padam rekod A, A, CNAME, MX, TXT, SRV, CAA dan lain-lain.

Lihat Dokumentasi
API Lokasi 2 Titik akhir

Senarai lokasi yang ada untuk pemasangan pelayan.

Lihat Dokumentasi
Akaun 1 Titik akhir

Dapatkan profil akaun dan maklumat token API. Identifikasi akaun mana yang token milik dan semak keizinan.

Lihat Dokumentasi
Affiliates 7 Titik akhir

Tarik baki afiliasi anda, rujukan, komisyen dan pembayaran ke dalam laporan anda sendiri, ubah tetapan pembayaran dan permintaan pembayaran.

Lihat Dokumentasi

Titik Akhir

API juga mempunyai titik hujung untuk pelaksanaan aplikasi (/api/v1/deploy-configs/ dan /api/v1/deployments/). Mereka tidak dinyatakan pada halaman ini lagi; rujukan interaktif senaraikan setiap titik hujung, dijana dari API hidup.

Buka rujukan API interaktif

Perlukan Bantuan?

Jika anda mempunyai soalan atau memerlukan bantuan dengan API, sila hubungi: