Tüm endpoint'ler application/json döner. Hatalar RFC 7807 (Problem+JSON) standardını izler. Her yanıt, sunucu tarafındaki denetim kaydıyla eşleştirme için X-Request-Id başlığı taşır.
| Method | Path | Kapsam/izin | Amaç |
|---|---|---|---|
| GET | /v1/health | public | Kimlik doğrulamasız sağlık kontrolü. |
| GET | /v1/me | any | Kendi hesap bilgisi ve anahtar üst verisi. |
| GET | /v1/products | read:products | Herkese açık listelenen tüm ürünlerin fiyatlarıyla listesi. |
| GET | /v1/products/{id} | read:products | Yapılandırma seçenekleri dahil ürün ayrıntıları. |
| POST | /v1/orders | write:orders | Yeni sipariş. Idempotency-Key zorunludur. |
| GET | /v1/orders/{id} | read:orders | Kendi siparişinizin durumu. |
| GET | /v1/services | read:services | Kendi servislerinizin listesi (sayfalanmış). |
| GET | /v1/services/{id} | read:services | Kendi servisinizin ayrıntıları. |
| GET | /v1/services/{id}/credentials | read:credentials | Erişim bilgileri (ayrı kapsam/izin, denetim kayıtlı). |
| POST | /v1/services/{id}/actions | write:services | Servis aksiyonu: start, stop, reboot, cancel (faturalama dönemi sonunda), cancel_revoke. |
| GET | /v1/billing/balance | read:billing | Bakiye. |
| GET | /v1/billing/invoices | read:billing | Faturalarınızın listesi (sayfalanmış). |
| GET | /v1/billing/invoices/{id}/pdf | read:billing | Fatura PDF'i. |
| GET | /v1/webhooks | read:webhooks | Geçerli webhook URL'si. |
| PUT | /v1/webhooks | write:webhooks | Webhook URL'sini ayarlama veya kaldırma. |
İdempotenlik
POST /v1/orders ve POST /v1/services/{id}/actions bir Idempotency-Key başlığı gerektirir ([A-Za-z0-9_.-] kümesinden 1 ile 80 arası karakter). Bu anahtar metoda, yola ve gövdeye bağlıdır. Aynı isteği aynı anahtarla bir saat içinde tekrarlarsanız saklanan yanıtı alırsınız; bu sürenin ardından reason replay_stale içeren bir 410 yanıtı döner ve yeni bir anahtar göndermeniz gerekir. Aynı anahtar farklı bir gövdeyle veya başka bir endpoint üzerinde kullanılırsa 409 idempotency_conflict ile reddedilir.
Hız sınırları
Varsayılan sınırlar: anahtar başına dakikada 60 istek (20 isteklik burst toleransıyla) ve günde 5.000 istek, tüm anahtarlar genelinde hesap başına dakikada 120 istek ve kaynak IP başına dakikada 600 istek. Bir sınır aşıldığında Retry-After başlığıyla birlikte HTTP 429 alırsınız. X-RateLimit-Remaining ve X-RateLimit-Reset yanıt başlıkları, anahtar sınırının güncel durumunu gösterir.
