Görseller API
Bir servis eklerken seçebileceğiniz hazır servis görselleri (veritabanları, önbellekler ve daha fazlası) olan build-image kataloğunu listeler.
Görseller API, build-image kataloğunu döndürür — bir projeye servis eklerken seçtiğiniz, özenle hazırlanmış hazır servis görsellerinin (PostgreSQL, Redis ve benzerleri) listesidir. dashboard'da bu, Servis ekle modalındaki görsel ızgarasıdır; bu salt okunur bir aramadır, bu nedenle oluşturulacak veya düzenlenecek bir şey yoktur.
Temel yol ve kimlik doğrulama
Tüm yollar, örneğinizle ilişkili olarak /api altında yer alır — örn. https://your-host/api/images.
alaf server token create ile oluşturulmuş kişisel bir erişim token'ını bearer header olarak gönderin (Authorization: Bearer <token>). dashboard bunun yerine oturum çerezinizi kullanır. Tam kimlik doğrulama modeli için API genel bakışına ve ayrıntılar için güvenlik/kimlik doğrulama bölümüne bakın.
Katalog Alaf Server Cloud'dan gelir
Modül her deploy modunda (self-hosted, cloud ve desktop) mevcuttur, ancak kataloğun kendisi Alaf Server Cloud tarafından sunulur. Bir SaaS örneğinde ana kataloğu kullanır; bir cloud hesabı bağlı olan self-hosted bir örnekte kuruluşunuzun cloud token'ını kullanır. Hiçbir cloud bağlantısı olmayan self-hosted bir örnekte, endpoint bir hata yerine cloudConnected: false ile boş bir liste döndürür — dashboard "Özel görsel" kutucuğuna geri döner. Sonuçlar birkaç dakika boyunca bellekte önbelleğe alınır.
Endpointler
| Method & path | Permission | What it does |
|---|---|---|
GET /api/images | authenticated | Mevcut build/servis görsellerini listeler, isteğe bağlı olarak ?search= ve ?category= ile filtrelenir. |
Bu rota ayrıntılı bir izin etiketi taşımaz — kuruluşun kimliği doğrulanmış herhangi bir üyesi kataloğu okuyabilir.
Görselleri listele
Kuruluşunuz için kataloğu döndürür. Her iki filtre de isteğe bağlıdır ve upstream katalog tarafından uygulanır; her şeyi almak için bunları atlayın.
GET /api/imagesProp
Type
curl https://your-host/api/images \
-H "Authorization: Bearer $ALAFSERVER_TOKEN"
# With filters:
curl "https://your-host/api/images?search=postgres&category=database" \
-H "Authorization: Bearer $ALAFSERVER_TOKEN"# Özel bir CLI fiili yok — kataloğa ham API komutu aracılığıyla ulaşın:
alaf server api /images
alaf server api /images -q search=postgres -q category=databaseYanıt { "success": true, "images": [ … ] } şeklindedir. Her giriş bir katalog görselini tanımlar; ortak alanlar id (seçtiğiniz slug), name (görünen ad), image (Docker görsel dizesi), description, category, logo, tags, ports ve defaultEnv (önerilen env anahtarları) şeklindedir. Upstream katalog tarafından döndürülen ek alanlar, ileriye dönük uyumluluk için değiştirilmeden aktarılır.
Görebileceğiniz hatalar
cloudConnected: false ile boş katalog
Bir hata değil. Cloud hesabı bağlı olmayan self-hosted bir örnekte, yanıt { "success": true, "images": [], "cloudConnected": false } şeklindedir. Kataloğu doldurmak için bir cloud hesabı bağlayın veya servise doğrudan özel bir görsel sağlayın.
500 — görseller listelenemedi
Upstream katalog çağrısı başarısız oldu. Yanıt { "success": false, "error": "…" } şeklindedir. Biraz sonra tekrar deneyin; sonuç bir kez getirildikten sonra önbelleğe alınır.
401 — yetkisiz
Geçerli bir oturum çerezi veya bearer token sağlanmadı. alaf server token create ile bir token oluşturun ve bunu Authorization: Bearer <token> olarak gönderin.