VPS.org API Belgelendirmesi

Başlarken

VPS.org API'si, sunucular, alan adları, DNS kayıtları, yedeklemeler ve anlık görüntüler de dahil olmak üzere VPS barındırma altyapınızın tüm yönlerini programatik olarak yönetmenize olanak tanır.

Kimlik doğrulama

Tüm API istekleri, Bearer token kullanılarak kimlik doğrulaması gerektirir. API token'ınızı hesap ayarlarınızdan oluşturabilirsiniz. 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);

Her token kendi izinlerini taşır, servers:list veya dns:* gibi. Token'ın sahip olmadığı bir izine ihtiyacı olan bir talep 403 ile ve kayıp izinin adını veren required_permission alanıyla reddedilir. İzin Referansları

Hız Sınırlama

Kimlik doğrulama işlemi yapılan talepler hesap başına saatte 1000 ile sınırlıdır. Kimlik doğrulama işlemi yapılmayan talepler IP adresi başına saatte 100 ile sınırlıdır. Limitin üzerindeki bir talepte bekleme saati saniyeleri veren Retry-After başlığı ile 429 alınır. Başarılı cevaplarda hız sınırı başlıkları gönderilmez.

Sayfalama

Liste son noktaları sayfa başına 25 nesne ile sayı, sonraki, önceki ve sonuçlarla bir nesne geri verir. Sayfalar arasında hareket etmek için sayfayı geç veya boşa kadar bir sonraki URL'yi izle. Sunucu listesi page_size'ı da kabul eder, 100'e kadar.

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

Hata Yönetimi

API, başarı veya başarısızlığı belirtmek için standart HTTP durum kodlarını kullanır:

Durum Kodu	Açıklama
`200`	Başarılı - İstek başarıyla tamamlandı.
`201`	Oluşturuldu - Kaynak başarıyla oluşturuldu.
`400`	Hatalı İstek - Geçersiz parametreler veya hatalı biçimlendirilmiş istek
`202`, `204`	Kabul edildi ve kuyruğa konuldu (202), veya cevap bedeni olmadan silindi (204)
`402`	Ödeme Gerekir: dosyada ödeme yöntemi yok, ödenmemiş faturalar veya kart ön onayı reddedildi
`403`	Yasaklandı: token kayıp, geçersiz veya geçmiş, ya da gerekli izinden yoksun. Başarısız kimlik doğrulama da 401 yerine 403 geri verir.
`404`	Bulunamadı - Kaynak mevcut değil.
`409`	Çatışma: örneğin, bir yeniden boyutlandırma süreci devam ediyor, yeterli kapasite yok veya bir uygulama zaten çalışıyor
`429`	Çok fazla istek - Hız sınırı aşıldı
`500`	Sunucu İçi Hata - Bizim tarafımızda bir sorun oluştu.
`503`	Hizmet Ulaşılamaz: geçici bir sorun. Yeniden deneyin, gönderildiğinde Retry-After'a saygı gösterin.

Hata bedenleri JSON'dur. Çoğu detay alanına veya hata alanına sahiptir, bazen bir mesajla; doğrulama hataları sorunları alan adı ile listeler.

API Kategorileri

API dokümantasyonumuza kategoriye göre göz atın:

Sunucular API'si 15 Uç noktalar

Sunucuları oluşturun, inceleyin, güçlendirin, yeniden boyutlandırın ve siliniz, root şifresini yeniden oluşturun, ters DNS'yi ayarlayınız, komutları çalıştırın ve SSH anahtarlarını yönetin.

Dokümantasyonu Görüntüle

Yedeklemeler API'si 4 Uç noktalar

Sunucu backup'larınızı listele, yeni bir backup başlat ve bir sunucuyu backup'tan geri getir.

Dokümantasyonu Görüntüle

Anlık Görüntüler API'si 4 Uç noktalar

Bir sunucunun etiketli fotoğraflarını alın, listeleyin ve siliniz.

Dokümantasyonu Görüntüle

Planlar API'si 2 Uç noktalar

Mevcut VPS planları ve fiyat bilgilerine ulaşın. Kaynaklar, fiyatlandırma ve kullanılabilirlik hakkında ayrıntılı bilgi edinin.

Dokümantasyonu Görüntüle

İşletim Sistemleri API'si 2 Uç noktalar

Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ve Alpine gibi kurulabilen işletim sistemleri ve sürümleri listele.

Dokümantasyonu Görüntüle

Alan adı API 7 Uç noktalar

Ulaşımlılığı kontrol edin, alan adlarını kaydedin ve yenileyin, isim sunucularını ve otomatik yenilemeyi ayarlayınız.

Dokümantasyonu Görüntüle

DNS API 13 Uç noktalar

DNS bölgeleri oluşturun ve A, A, CNAME, MX, TXT, SRV, CAA ve diğer kayıtları oluşturun, güncelleyin ve siliniz.

Dokümantasyonu Görüntüle

Konumlar API'si 2 Uç noktalar

Sunucu yerleştirme için mevcut konumları listeler.

Dokümantasyonu Görüntüle

Hesap 1 Uç noktalar

Hesap profili ve API token bilgisini al. Token'in hangi hesaba ait olduğunu belirle ve izinlerini kontrol et.

Dokümantasyonu Görüntüle

Affiliates 7 Uç noktalar

Affiliate balansınızı, referanslarınızı, komisyonlarınızı ve ödemelerinizi kendi raporlarınıza çekin, ödeme ayarlarını değiştirin ve ödeme talep edin.

Dokümantasyonu Görüntüle

Daha Fazla Son Noktalar

API ayrıca uygulama dağıtımları için son noktalara sahiptir (/api/v1/deploy-configs/ ve /api/v1/deployments/). Bu sayfalarda henüz tanımlanmamışlardır; etkileşimli referans, canlı API'den üretilen her son noktayı listeler.

Etkileşimli API referansını aç

Yardıma mı ihtiyacınız var?

API ile ilgili sorularınız varsa veya yardıma ihtiyacınız olursa lütfen bizimle iletişime geçmekten çekinmeyin:

Destek Talepleri: Destek talebi oluşturun
E-posta: hello@vps.org
Belgelendirme: Tam Dokümantasyon