Alan Adları API'si
Bir projeye özel alan adları ekleyin, DNS'i önizleyin ve doğrulayın, ve SSL sertifikalarını yönetin.
Alan Adları API'si, web adreslerini (örneğin app.example.com) bir projeye ekler, DNS'in doğru şekilde kurulduğunu kontrol eder ve HTTPS sertifikasını yönetir. Dashboard'da bu, projenin Alan Adları sekmesidir; terminalden ise alaf server domain komutudur.
Temel yol ve kimlik doğrulama
Tüm yollar, örneğin https://your-host/api/domains gibi, kendi instance'ınızın /api altında görecelidir. alaf server token create ile oluşturulmuş bir kişisel erişim token'ını bearer header olarak (Authorization: Bearer <token>) gönderin. Dashboard bunun yerine oturum çerezinizi kullanır. Tam kimlik doğrulama modeli için API genel bakışına bakın.
Uç Noktalar
| Metot ve yol | İzin | Ne yapar |
|---|---|---|
GET /api/domains | domain:list | Alan adlarını listeler (isteğe bağlı olarak ?projectId=). |
POST /api/domains | domain:write | Bir projeye alan adı ekler. |
POST /api/domains/preview | domain:read | Bir hostname'in ihtiyaç duyacağı DNS kayıtlarını önizler — hiçbir şey oluşturmaz. |
DELETE /api/domains/:id | domain:admin | Bir alan adını kaldırır. |
POST /api/domains/:id/verify | domain:write | Bir alan adı için sahipliği / DNS'i doğrular. |
POST /api/domains/:id/primary | domain:write | Bunu projenin birincil alan adı yapar. |
GET /api/domains/:id/records | domain:read | Bir alan adı için DNS kayıtlarını alır. |
POST /api/domains/:id/renew | domain:write | SSL sertifikasını yeniler. |
POST /api/domains/:id/verify-ssl | domain:write | SSL sertifikasını kontrol eder. |
POST /api/domains/renew-all | domain:write | Süresi dolan her sertifikayı yeniler. |
POST /api/domains/verify-pending | domain:write | Hala beklemede olan tüm alan adlarını yeniden doğrular. |
Alan adı ekle
POST /api/domainsProp
Type
curl -X POST https://your-host/api/domains \
-H "Authorization: Bearer $ALAFSERVER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"proj_123","hostname":"app.example.com"}'# CLI'dan aynı şey:
alaf server domain add app.example.comAlan adı eklemek onu tek başına aktif hale getirmez
Ekledikten sonra, DNS'inizi Alaf Server'a yönlendirmeli ve ardından doğrulamalısınız. DNS sağlayıcınızda eklenecek tam kayıtları görmek için önce POST /api/domains/preview (veya alaf server domain preview <hostname>) kullanın.
Gerekli DNS'i önizle
Yan etkisi yoktur: bir hostname geçirin, oluşturulacak kayıtları geri alın. POST yalnızca hostname'in body'de taşınması için kullanılır.
POST /api/domains/previewcurl -X POST https://your-host/api/domains/preview \
-H "Authorization: Bearer $ALAFSERVER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hostname":"app.example.com"}'Yanıtın mode'u hangi kurulumun geçerli olduğunu söyler: selfhosted (sunucunuza bir A kaydı), cloud (Alaf Server Cloud'a bir CNAME) veya external (yalnızca bir TXT kaydı — TLS'i kendiniz önden sağlarsınız).
Bir alan adını doğrula
DNS yerleştirildikten sonra, onu doğrulayın. Alaf Server yönlendirme kaydını ve sahiplik TXT kaydını kontrol eder, alan adını aktif olarak işaretler ve (external-ingress değilse) arka planda SSL sağlar.
POST /api/domains/:id/verifyalaf server domain verify <domainId>Görebileceğiniz hatalar
422 — doğrulama başarısız oldu
DNS kayıtları henüz çözümlenmiyor veya eşleşmiyor. DNS'in yayılması dakikalar ila saatler sürebilir. Kayıtların preview ile tam olarak eşleştiğini onaylayın, ardından tekrar deneyin. Yanıtın cnameVerified / txtVerified bayrakları, hangi kontrolün hala başarısız olduğunu size söyler.
Alan adına özel bir rotada 404
':id' kuruluşunuza ait değil (veya silinmiş). Geçerli ID'leri almak için alan adlarınızı GET /api/domains ile listeleyin.
Servisler API'si
Bir projenin içindeki servisleri (compose servisleri ve monorepo alt uygulamaları) yönetin — CRUD, compose'dan senkronizasyon, container eylemleri, drift çözümü ve ortam değişkenleri dahil.
GitHub API
Bir GitHub hesabı veya Uygulaması bağlayın, repoları, dalları ve dosyaları tarayın ve push webhook'larını yönetin.