Tek token, panelden oluşturulur
Bearer token olarak gönderilir. İsterseniz salt okunur veya tek bir hizmetle sınırlandırabilirsiniz; tokenlar parolanızdan bağımsızdır ve birini iptal etmek sizi asla oturumdan çıkarmaz.
Tek token, panelin yapabildiği her şey
HTTPS üzerinden JSON. SDK gerekmez, ayrı bir geliştirici hesabı gerekmez ve panelde olup burada olmayan bir endpoint yoktur.
Sunucu oluşturun
curl -X POST https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN" \
-d '{"plan":"reef","image":"debian-13"}'Hemen bir oluşturma kimliği döndürür. Makine yaklaşık altmış saniye sonra SSH üzerinden yanıt verir ve kimlik bilgileri gönderilmeden önce adres yönlendirilir.
20 uç nokta
Beş grup halinde her şey
Temel URL https://api.vpsoffshore.com/v1. Sürüm numarası yol içinde yer alır; v2 devreye girdiğinde v1 çalışmaya devam eder ve durdurulacağı tarih bir yıl önceden duyurulur.
Sunucular
GET
/servers
Hesaptaki her hizmet, durumu, planı ve adresleriyle birlikte.
POST
/servers
Bir tane oluşturun. Hemen bir build id ile döner; sunucu yaklaşık bir dakika sonra erişilebilir olur.
GET
/servers/{id}
Son bir saatteki canlı kaynak kullanımı dahil, tek bir hizmet.
PATCH
/servers/{id}
Planı değiştirin. Disk izin verdiğinde yeniden kurulum yapılmadan yeniden boyutlandırılır.
DELETE
/servers/{id}
Silin. Diskler 14 gün saklanır, ardından yeniden verilmeden önce temizlenir.
POST
/servers/{id}/actions
reboot · shutdown · start · rebuild · rescue · reset-password.
Depolama
GET
/servers/{id}/snapshots
Tek bir hizmete ait anlık görüntüler, en yeniden eskiye.
POST
/servers/{id}/snapshots
Bir tane alın. İnce yapıdadır, bu yüzden hızlıdır ve disk kullanımınızı ikiye katlamaz.
POST
/snapshots/{id}/restore
Aynı yerde geri yükleyin ya da aynı ya da daha büyük bir plana sahip başka bir hizmete.
DELETE
/snapshots/{id}
Bir anlık görüntüyü kaldırın.
Ağ
GET
/servers/{id}/addresses
Bir hizmete yönlendirilmiş adresler, v4 ve v6.
POST
/servers/{id}/addresses
Ek bir adres veya bir /29 talep edin.
PUT
/addresses/{ip}/rdns
Ters DNS'i ayarlayın. Bir sonraki bölge yenilemesinde değil, bir dakika içinde etkin olur.
GET
/servers/{id}/bandwidth
Aktarım sayaçları. Bilgi amaçlıdır — aşılabilecek bir kota yoktur.
Katalog
GET
/plans
Her planın özellikleri ve fiyatıyla birlikte tamamı. Bu sitenin oluşturulduğu kaynağın ta kendisi.
GET
/images
Yüklediğiniz imgeler de dahil olmak üzere kullanılabilir imgeler ve ISO'lar.
POST
/images
Bir ISO'yu URL ile yükleyin. Konsol bağlı şekilde önyükleme yapar.
Faturalandırma
GET
/invoices
Ödenmiş ve bekleyen faturalar, koin ve zincir işlemiyle birlikte.
POST
/invoices/{id}/pay
8 kabul edilen koinden biri için bir ödeme adresi oluşturun.
GET
/credits
Uygulanan SLA telafileri, her birini doğuran olayla birlikte.
Müşteri panelinin yapabildiği her şey buradadır ve burada olup panelde bulunmayan hiçbir şey yoktur. İkisi çelişirse bu bir hatadır — bunu panelden bize bildirin ve olması gereken davranış olarak belgelenmek yerine düzeltilir.
Nasıl davranır
Bir saat içinde fark edeceğiniz dört karar
Bir API, iyi senaryolarına değil kötü senaryolarına göre değerlendirilir. Aşağıdaki dördün üçü, bir şeyler ters gittiğinde ne olduğuyla ilgilidir.
JSON girer, JSON çıkar, SDK gerekmez
Özel bir zarf, XML yedek çözümü ya da imzalama ritüeli olmayan sade HTTPS. curl bunu yapabiliyorsa, sizin de bir istemciniz var demektir. Go, Python ve TypeScript için resmi kütüphaneler mevcuttur ve hiçbiri zorunlu değildir.
Yanlışlıkla aşmayacağınız hız sınırları
Token başına dakikada 600 istek, oluşturma çağrıları için ise 60 istek. Her yanıt, kalan kotayı bir başlıkta taşır; sınır aşıldığında beklenmesi gereken saniye sayısıyla birlikte 429 döner — asla sessizce düşürülmez.
Ne yapılması gerektiğini söyleyen hatalar
Bir 4xx yanıtı; makine tarafından okunabilir bir kod, anlaşılır bir cümle ve hatalı alanı birlikte taşır. Tahmin etmeniz gereken kısa bir hata yerine uzun bir hata döndürmeyi tercih ederiz.
Bir kez yazdığınız iki şey
Kimlik doğrulama ve bir hatanın nasıl göründüğü
İkisini de ilk çağrıyı yazmadan önce okumak, ilk hatadan sonra okumaktan daha değerlidir.
Kimlik doğrulayın
curl https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN"Token'lar panelde oluşturulur ve salt okunur ya da tek bir hizmetle sınırlandırılabilir. Şifrenizden bağımsızdırlar ve birini iptal etmek sizi hiçbir yerden oturumdan çıkarmaz.
Hız sınırını okuyun
X-RateLimit-Remaining: 574
X-RateLimit-Reset: 41Yalnızca başarısız olan yanıtta değil, her yanıtta. Sınırın aşılması, beklenecek saniyeyle birlikte 429 döner; asla sessiz bir düşüş, asla kısaltılmış bir yanıt olmaz.
Hata size ilgili alanı bildirir
{"error":"plan_unknown",
"message":"No plan named 'reff'. Did you mean 'reef'?",
"field":"plan"}Makine tarafından okunabilir bir kod, insan diliyle bir cümle ve hatalı alan. Uzun hata mesajları, tahmin etmeniz gereken kısa olanlardan daha ucuzdur.
Bir kurulumu sorgulayın
curl https://api.vpsoffshore.com/v1/servers/$ID \
-H "Authorization: Bearer $TOKEN" | jq .statebuilding → running durumuna geçer. Herhangi bir şey oluşturmadan önce kaydetmeniz gereken bir webhook yoktur ve saniyede bir yapılan polling sınır dahilindedir.
Başvurulacak bir şey yok
Token panelde bulunur ve panel ilk sunucuyla birlikte gelir
Geliştirici hesabı yok, onay yok, üretimden farklı davranan bir sandbox yok.
Sonraki okuma
Buradan sonra nereye bakmalı