REST API · OpenAPI 3

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

  1. Panele girin ve Ayarlar → API anahtarları → Yeni anahtar sayfasını açın.
  2. 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.
  3. 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

KodAnlamı
401Anahtar yok, geçersiz, süresi dolmuş ya da iptal edilmiş.
403Anahtarın bu işlem için izni yok ya da istek IP kısıtının dışından geldi.
404Kaynak yok ya da hesabınıza ait değil.
409Bir kural engelledi (plan sınırı, güncel olmayan revision, devam eden iş).
429Hı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.

İzinNe sağlar
subscriptionsAbonelik, alan adı, site ayarları, WordPress, Node.js, site değişkenleri
mailE-posta kutuları, yönlendirme, otomatik yanıt, DKIM ve DMARC
databasesVeritabanı oluşturma, içe ve dışa aktarma
filesDosya yöneticisi: listeleme, indirme, yükleme, düzenleme
sftpSFTP erişimi, parola ve SSH anahtarları
certificatesSSL sertifikaları
backupsOkuma: yedekleri listeleme ve önizleme. Yazma: yedek alma ve geri yükleme
cronZamanlanmış görevler
dnsDNS kayıtları
jobsİş durumlarını izleme, yeniden deneme
alerts:read, audit:readUyarı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