API'ye başlarken.
Panelde yaptığınız her işlem genel API'den de yapılır. Sitelerinizi, e-postanızı, veritabanlarınızı ve yedeklerinizi kendi betiklerinizden, otomasyon araçlarınızdan ya da yapay zekâ asistanınızdan yönetebilirsiniz. Bu sayfa ilk isteğinizi göndermeniz için gerekenleri anlatır.
API anahtarınızı oluşturun
- Panele girin ve Ayarlar → API anahtarları → Yeni anahtar sayfasını açın.
- Anahtara bir ad verin (ör. "yedek betiği"), yalnız ihtiyacınız olan izinleri ve geçerlilik süresini seçin (en çok 365 gün). İsterseniz anahtarı belirli IP adresleriyle sınırlayın.
- Anahtar yalnız bir kez gösterilir. Hemen parola yöneticinize kaydedin. Kaybederseniz eskisini iptal edip yenisini oluşturun.
Anahtar yalnız sizin hesabınızın kaynaklarında ve yalnız verdiğiniz izinlerle çalışır; hesabınızın sahip olduğu öteki yetkileri taşımaz. Planınızın sınırları (alan adı, e-posta kutusu, disk, veritabanı sayısı) API'de de aynen geçerlidir.
Bağlantı bilgileri
- API adresi
https://PANEL_ADRESINIZ:8443/api/v1- Kimlik doğrulama
Authorization: Bearer hkp_…- Veri biçimi
- JSON,
Content-Type: application/json - Şema (OpenAPI)
GET /api/v1/openapi.json
Panelinizin adresi, giriş yaptığınız adresle aynıdır. OpenAPI dosyasını Postman, Insomnia ya da Swagger Editor'e aktarırsanız bütün uç noktaları ve alanları görürsünüz. Aynı liste panelde API anahtarları sayfasındaki "API'ye başlarken" bölümünde de aranabilir biçimde durur; her uç noktanın istediği izin orada yazılıdır.
İlk istekler
Örneklerde anahtarın XENON_API_KEY, panel adresinin XENON ortam değişkeninde olduğu varsayılır:
export XENON=https://PANEL_ADRESINIZ:8443/api/v1
export XENON_API_KEY=hkp_... # kod deposuna yazmayın
Aboneliklerinizi listeleyin
curl -s "$XENON/subscriptions" \
-H "Authorization: Bearer $XENON_API_KEY"
Alan adınızın kimliğini bulun
curl -s "$XENON/domains?q=example.com" \
-H "Authorization: Bearer $XENON_API_KEY"
Yeni e-posta kutusu açın
Önce GET /domains/{id}/mail ile güncel revision değerini alın; eşzamanlı iki değişiklik birbirini ezmez.
curl -s -X PUT "$XENON/domains/ALAN_ADI_KIMLIGI/mail" \
-H "Authorization: Bearer $XENON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"revision": 3, "enabled": true,
"mailbox": {"local_part": "info", "enabled": true,
"quota_mb": 1024, "password": "GüçlüBirParola!2026"}}'
Veritabanı oluşturun
curl -s -X POST "$XENON/subscriptions/ABONELIK_KIMLIGI/databases" \
-H "Authorization: Bearer $XENON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"label": "magaza", "engine": "mariadb"}'
Anlık yedek alın ve sonucu izleyin
curl -s -X POST "$XENON/subscriptions/ABONELIK_KIMLIGI/backups" \
-H "Authorization: Bearer $XENON_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"
# yanıt: {"data": {"job_id": "…"}}
curl -s "$XENON/jobs/IS_KIMLIGI" \
-H "Authorization: Bearer $XENON_API_KEY"
Yanıtlar, işler ve hatalar
- Başarılı yanıt:
{"data": …, "request_id": "…"} - Hata:
{"error": {"code": "…", "message": "…"}, "request_id": "…"}. Destek isterkenrequest_iddeğerini iletin. - Sunucuda zaman alan işlemler (kutu açma, veritabanı, yedek) 202 ve bir
job_iddöndürür. SonucuGET /api/v1/jobs/{job_id}ile izleyin. - Ağ kopmalarına karşı değiştirici isteklere
Idempotency-Keybaşlığı ekleyin; aynı anahtarla gelen ikinci istek yeni iş açmaz.
| Kod | Anlamı |
|---|---|
401 | Anahtar yok, geçersiz, süresi dolmuş ya da iptal edilmiş. |
403 | Anahtarın bu işlem için izni yok ya da istek IP kısıtının dışından geldi. |
404 | Kaynak yok ya da hesabınıza ait değil. |
409 | Bir kural engelledi (plan sınırı, güncel olmayan revision, devam eden iş). |
429 | Hız sınırı. Retry-After başlığındaki süre kadar bekleyin. |
İzinler
Okuma izinleri :read, değiştirme izinleri :write ile biter. Anahtara yalnız gereken izinleri verin.
| İzin | Ne sağlar |
|---|---|
subscriptions | Abonelik, alan adı, site ayarları, WordPress, Node.js, site değişkenleri |
mail | E-posta kutuları, yönlendirme, otomatik yanıt, DKIM ve DMARC |
databases | Veritabanı oluşturma, içe ve dışa aktarma |
files | Dosya yöneticisi: listeleme, indirme, yükleme, düzenleme |
sftp | SFTP erişimi, parola ve SSH anahtarları |
certificates | SSL sertifikaları |
backups | Okuma: yedekleri listeleme ve önizleme. Yazma: yedek alma ve geri yükleme |
cron | Zamanlanmış görevler |
dns | DNS kayıtları |
jobs | İş durumlarını izleme, yeniden deneme |
alerts:read, audit:read | Uyarılar ve işlem kayıtları |
Kullanıcı ve API anahtarı yönetimi, güvenlik ayarları ve phpMyAdmin girişi güvenlik gereği yalnız panelden yapılır; bir anahtar başka bir anahtar oluşturamaz.
Güvenlik önerileri
- Anahtarı kod deposuna yazmayın; ortam değişkeninde ya da gizli değer yöneticisinde tutun.
- Sabit bir sunucudan kullanıyorsanız anahtara IP kısıtı koyun.
- Kısa süreli anahtar tercih edin. Süresi dolan anahtar kendiliğinden geçersiz olur.
- Her anahtarın kullanım geçmişi 90 gün tutulur. Tanımadığınız bir kullanım görürseniz anahtarı hemen iptal edin.
- Bir hesapta aynı anda en çok 20 etkin anahtar olabilir. Kullanmadığınız anahtarları iptal edin.
- Aynı adresten dakikada 20'den fazla geçersiz anahtar denemesi bir dakika 429 ile reddedilir; betiğiniz bu yanıtta beklemeli.
- Yapay zekâ asistanına anahtar verirken yalnız okuma izniyle başlayın; değiştirme iznini gerektiğinde ve kısa süreli bir anahtarla verin.