Nexren Shield API v1.0
Endpoint, metot veya konu ara... (Ctrl + K)
⌘K
Nexren Shield REST API v1.0 Müşteri paneliniz üzerindeki tüm güvenlik kontrolleri, site yönetimi, Origin Lock, önbellek temizleme, canlı saldırı günlükleri ve API token kontrollerini güvenle yönetin.
BASE URL
https://shield.nexren.info/api
Tüm REST v1 istekleri için global HTTPS uç noktası
FORMAT & ENCODING
application/json
UTF-8 JSON yükleri ve standart HTTP durum kodları
KİMLİK DOĞRULAMA
Bearer nx_live_...
Token tabanlı SHA-256 yetkilendirme başlığı
RATE LIMIT
120 Req / Dk
Token başına kayan pencereli hız kısıtlaması
Hemen Site Ekle (POST /v1/sites) API Tokenı Oluştur Kimlik Doğrulama Rehberi → Hata Kodları Kataloğu →
Kimlik Doğrulama (Authentication) REST API isteklerinde güvenli yetkilendirme standartları ve HTTP başlık yapılandırması.

Nexren Shield REST API'ye yapılan tüm istekler HTTP Authorization başlığında Bearer formatında bir API Token anahtarı içermelidir. API anahtarlarınızı müşteri paneliniz üzerinden API Anahtarları sekmesinden veya Token Oluşturma Endpointi ile oluşturabilirsiniz.

HTTP Authorization Header Örneği
curl -H "Authorization: Bearer $NEXREN_API_KEY" \
     https://shield.nexren.info/api/v1/sites
API Tokenı Oluşturma Endpointi → Token Yetkilerini Test Et (/v1/whoami) →
Hız Sınırları (Rate Limits) Sistem kaynaklarının kararlı ve adil dağıtımı için token başına uygulanan hız kısıtlama kuralları.

Shield REST API v1, sistem kaynaklarının adil ve kararlı kullanımını güvenceye almak için token bazlı 120 istek / dakika kayan pencereli (sliding-window) hız kısıtlaması uygular.

HTTP Yanıt BaşlığıTürAçıklama
X-RateLimit-LimitintegerDakikalık toplam istek kotanız (120).
X-RateLimit-RemainingintegerMevcut pencerede kalan istek hakkınız.
X-RateLimit-ResettimestampKotanın sıfırlanacağı Unix epoch saniyesi.
HTTP Durum Kodları & Hata Formatı Tüm REST API v1 yanıtlarında kullanılan standart durum kodları ve JSON hata nesnesi yapısı.

Standart Hata Yanıt Şeması (Error Response Object)

İstek başarısız olduğunda dönen standart JSON gövdesi.

HTTP 4xx / 5xx application/json
{
  "error": "unauthorized",
  "message": "Invalid or expired API token",
  "status": 401
}

HTTP Durum Kodları Kataloğu

Olası HTTP yanıt kodları, anlamları ve geliştirici çözüm yolları.

HTTP KoduDurumAçıklama & Çözüm
200 OKBaşarılıİstek başarıyla işlendi ve beklenen veri nesnesi döndürüldü.
201 CreatedOluşturulduYeni kaynak (Web Sitesi, API Tokenı vb.) başarıyla oluşturuldu.
204 No Contentİçerik Yokİşlem başarıyla tamamlandı, yanıt gövdesinde veri döndürülmez.
400 Bad RequestHatalı İstekEksik parametre, hatalı JSON sözdizimi veya doğrulanamayan payload formatı. İstek gövdesini kontrol edin.
401 UnauthorizedYetkisizAPI Token anahtarı eksik, geçersiz veya süresi dolmuş. Authorization: Bearer nx_live_... başlığını doğrulayın.
403 ForbiddenYasaklandıKullanılan API Token'ının yetki kapsamı (Scope) bu işlem için yetersiz veya IP kısıtlaması uyuşmuyor.
404 Not FoundBulunamadıBelirtilen domain veya ID'ye sahip web sitesi ya da token bulunamadı (Strict Tenant İzolasyonu gereği diğer kullanıcılara ait nesneler 404 döner).
409 ConflictÇakışmaEklenmek istenen domain veya kaynak sistemde zaten kayıtlı.
429 Too Many RequestsHız Sınırı AşıldıDakikalık 120 istek kotası aşıldı. X-RateLimit-Reset süresini bekleyin.
500 Internal ErrorSunucu HatasıSunucu tarafında beklenmeyen bir hata meydana geldi.
502 Bad GatewayGeçersiz Ağ GeçidiOrigin sunucunuza ulaşılamadı veya bağlantı zaman aşımına uğradı.
Web Siteleri Yönetimi (Sites)
Scope: sites:*
Nexren Shield WAF ve DDoS koruma kalkanına yeni domain ekleme, mevcut siteleri listeleme, koruma modlarını değiştirme, origin sunucu ayarları ve Edge önbellek temizleme (purge cache) işlemlerini programatik olarak yönetin.
Otomatik SSL Provizyonu
Yeni eklenen her alan adı için küresel Edge düğümlerinde otomatik TLS sertifikası üretilir.
Koruma Seviyesi Modları
Sitelerinizi Off, Monitor, Balanced veya Under Attack modlarına anlık API çağrılarıyla geçirin.
Küresel Önbellek Temizleme
Tek bir POST isteği ile tüm dünya genelindeki Edge sunuculardan önbelleği anında temizleyin.

Kategori Uç Noktaları (Endpoints)

Bu kategori altında yer alan tüm REST API uç noktaları.

GET /api/v1/sites Web Sitelerini Listele
sites:read İncele →
POST /api/v1/sites Yeni Web Sitesi Ekle
sites:write İncele →
GET /api/v1/sites/{id} Web Sitesi Detayları
sites:read İncele →
PATCH /api/v1/sites/{id} Site Ayarlarını Güncelle
sites:write İncele →
DELETE /api/v1/sites/{id} Web Sitesini Sil
sites:delete İncele →
POST /api/v1/sites/{id}/purge-cache Önbelleği Temizle (Purge Cache)
sites:write İncele →
Origin & Origin Lock (Kaynak Sunucu Güvenliği)
Scope: sites:*
Backend sunucunuzun IP ve Host ayarlarını yapılandırın. Origin Lock ile doğrudan IP saldırılarına karşı kaynak sunucunuzu tam korumaya alın.
Origin Lock Koruması
Kaynak sunucunuza yalnızca Nexren Shield kriptografik gizli başlığıyla gelen isteklerin ulaşmasını sağlayın.
Host Başlığı & Zaman Aşımı
Origin sunucunuza iletilecek Host başlığını ve gecikme zaman aşımı limitlerini kolayca güncelleyin.

Kategori Uç Noktaları (Endpoints)

Bu kategori altında yer alan tüm REST API uç noktaları.

GET /api/v1/sites/{id}/origin Origin Bilgisini Al
sites:read İncele →
PUT /api/v1/sites/{id}/origin Origin Yapılandırmasını Güncelle
sites:write İncele →
POST /api/v1/sites/{id}/origin/lock/toggle Origin Lock Aç / Kapat
sites:write İncele →
Güvenlik Politikaları & WAF
Scope: policies:*
DDoS koruma kalkanı, IP başına hız sınırlamaları (rate limit), otomatik bot doğrulama (challenge) ve özel güvenlik filtrelerini dinamik olarak yönetin.
Hız Sınırlamaları (Rate Limiting)
IP başına saniyelik maksimum istek sınırı (RPS) tanımlayarak brute-force ve Layer 7 saldırılarını önleyin.
Otomatik Bot DDoS Challenge
Şüpheli bot trafiğinde tarayıcıya otomatik JavaScript PoW ve CAPTCHA doğrulama uygulayın.

Kategori Uç Noktaları (Endpoints)

Bu kategori altında yer alan tüm REST API uç noktaları.

GET /api/v1/policies/{id} Politika Ayarlarını Al
policies:read İncele →
PUT /api/v1/policies/{id} Politika & WAF Kurallarını Güncelle
policies:write İncele →
Güvenlik Günlükleri & Analitik
Scope: events:read, analytics:read
WAF ve DDoS koruma katmanları tarafından filtrelenen veya engellenen saldırı loglarını, saldırgan IP'leri, tehdit nedenlerini ve 24 saatlik trafik metriklerini sorgulayın.
Canlı Tehdit Günlükleri
Engellenen isteklerin IP, ülke, URL, HTTP metodu, User-Agent ve eşleşen kural detaylarını inceleyin.
Trafik & Tehdit Metrikleri
Son 24 saatteki temiz trafik, engellenen saldırılar, önbellek isabet oranı ve ortalama gecikme sürelerini alın.

Kategori Uç Noktaları (Endpoints)

Bu kategori altında yer alan tüm REST API uç noktaları.

GET /api/v1/events Canlı Güvenlik Olayları & Saldırı Kayıtları
events:read İncele →
GET /api/v1/analytics/summary Trafik & Tehdit Analitiği Özeti
analytics:read İncele →
API Token Yönetimi (API Keys)
Scope: tokens:*
REST API v1 erişimi için yetki kapsamlarına (scopes), geçerlilik sürelerine ve opsiyonel IP/CIDR kısıtlamalarına sahip anahtarlar üretin ve iptal edin.
Granüler Yetki Kapsamları (Scopes)
Siteler, politikalar, analitik ve token yönetimi için ayrıştırılmış okuma/yazma izinleri atayın.
IP / CIDR Kısıtlaması
API anahtarının yalnızca yetkili sunucu IP'lerinden veya CIDR bloklarından kullanılmasına izin verin.

Kategori Uç Noktaları (Endpoints)

Bu kategori altında yer alan tüm REST API uç noktaları.

GET /api/v1/tokens API Tokenlarını Listele
tokens:read İncele →
POST /api/v1/tokens Yeni API Tokenı Oluştur
tokens:write İncele →
DELETE /api/v1/tokens/{id} API Tokenını İptal Et / Sil
tokens:write İncele →
Kimlik & Token Durumu (Identity)
Scope: whoami
İstekte kullanılan API Token anahtarının durumunu, yetki kapsamlarını, istemci IP adresini ve kalan hız sınırını anlık doğrulayın.
Anlık Token Doğrulama
Token'ın aktifliğini, kalan kota limitini ve izin verilen yetki kapsamlarını tek çağrıda test edin.

Kategori Uç Noktaları (Endpoints)

Bu kategori altında yer alan tüm REST API uç noktaları.

GET /api/v1/whoami Aktif Token & Yetki Durumu
whoami İncele →
Web Sitelerini Listele
GET /api/v1/sites Scope: sites:read

Hesabınıza tanımlı tüm web sitelerinin listesini, aktif koruma modlarını (Off, Monitor, Balanced, Under Attack), origin hedeflerini, SSL durumlarını ve trafik özetini döndürür.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer formatında geçerli API Token anahtarı (nx_live_...) Örnek: Bearer $NEXREN_API_KEY

Sorgu Parametreleri (Query Parameters)

URL sorgu dizgisi (query string) ile filtreleme seçenekleri.

ParametreTürDurumAçıklama & Seçenekler
includePending boolean Opsiyonel
DNS doğrulaması bekleyen siteleri listeye dahil et. Varsayılan: false
search string Opsiyonel
Domain adına göre anahtar kelime filtrelemesi yap (örn: 'api.example').

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/sites" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "sites": [
    {
      "id": "site_9f81a7b2",
      "domain": "tahablt.com.tr",
      "originUrl": "https://85.235.75.211:443",
      "mode": "Balanced",
      "enabled": true,
      "sslStatus": "active",
      "underAttack": false,
      "totalRequests24h": 142050,
      "blockedRequests24h": 3210,
      "createdAt": "2026-03-10T12:00:00Z"
    }
  ],
  "total": 1
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

Yeni Web Sitesi Ekle
POST /api/v1/sites Scope: sites:write

Nexren Shield WAF ve DDoS koruma kalkanına yeni bir alan adı (domain) ekler. Otomatik SSL provizyonunu başlatır ve koruma modunu belirler.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer formatında API Token anahtarı Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
domain string Zorunlu
Korumaya alınacak tam alan adı (örn: 'tahablt.com.tr' veya 'api.example.com').
originUrl string Zorunlu
Trafiğin iletileceği gerçek kaynak sunucu URL adresi (IP veya Hostname).
mode string Opsiyonel
Başlangıç koruma modu seviyesi. Varsayılan: Balanced
Seçenekler:
Off Monitor Balanced Under Attack

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X POST "https://shield.nexren.info/api/v1/sites" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "domain": "tahablt.com.tr",
  "originUrl": "https://85.235.75.211:443",
  "mode": "Balanced"
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 201 Created application/json
{
  "site": {
    "id": "site_9f81a7b2",
    "domain": "tahablt.com.tr",
    "originUrl": "https://85.235.75.211:443",
    "mode": "Balanced",
    "enabled": true,
    "cnameTarget": "shield.nexren.info",
    "sslStatus": "pending_validation",
    "createdAt": "2026-08-31T20:00:00Z"
  },
  "message": "Web site successfully registered to Nexren Shield protection"
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

Web Sitesi Detayları
GET /api/v1/sites/{id} Scope: sites:read

Belirtilen domain adı (örn: 'tahablt.com.tr') veya Site ID'sine sahip sitenin detaylı durumunu, DNS yönlendirme hedefini, Origin bağlantı durumunu ve aktif WAF kural sayısını getirir.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef web sitesinin domain adı (örn: 'tahablt.com.tr') veya Site ID'si (site_...). Her API anahtarı yalnızca kendi sitelerini yönetebilir. Örnek: tahablt.com.tr

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "site": {
    "id": "site_9f81a7b2",
    "domain": "tahablt.com.tr",
    "originUrl": "https://85.235.75.211:443",
    "mode": "Balanced",
    "enabled": true,
    "sslStatus": "active",
    "cnameTarget": "shield.nexren.info",
    "originLockEnabled": true,
    "underAttack": false,
    "activeRulesCount": 8
  }
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Site Ayarlarını Güncelle
PATCH /api/v1/sites/{id} Scope: sites:write

Sitenin koruma modunu (Off, Monitor, Balanced, Under Attack) anında değiştirin, kalkanı duraklatın veya origin sunucu adresini güncelleyin.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Site ID Örnek: tahablt.com.tr

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
mode string Opsiyonel
Yeni koruma modu seviyesi.
Seçenekler:
Off Monitor Balanced Under Attack
originUrl string Opsiyonel
Yeni backend origin adresi.
enabled boolean Opsiyonel
Kalkan korumasını aktif (true) veya pasif (false) yap.

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X PATCH "https://shield.nexren.info/api/v1/sites/{id}" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "mode": "Under Attack"
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "message": "Site protection parameters updated successfully",
  "site": {
    "id": "site_9f81a7b2",
    "domain": "tahablt.com.tr",
    "mode": "Under Attack",
    "enabled": true
  }
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Web Sitesini Sil
DEL /api/v1/sites/{id} Scope: sites:delete

Web sitesini ve ilişkili tüm WAF kurallarını, SSL sertifikalarını ve önbellek yapılandırmasını Nexren Shield kalkanından tamamen kaldırır.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Silinecek domain adı (örn: 'tahablt.com.tr') veya Site ID Örnek: tahablt.com.tr

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X DELETE "https://shield.nexren.info/api/v1/sites/{id}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "message": "Web site tahablt.com.tr successfully removed from Shield"
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Önbelleği Temizle (Purge Cache)
POST /api/v1/sites/{id}/purge-cache Scope: sites:write

Nexren Shield Edge düğümlerinde saklanan statik ve dinamik önbellek içeriklerini küresel olarak anında temizler.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Site ID Örnek: tahablt.com.tr

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
purgeAll boolean Opsiyonel
Tüm alan adı önbelleğini sıfırla. Varsayılan: true
paths array Opsiyonel
Yalnızca belirli URL yollarını temizle (örn: ['/static/app.js', '/assets/*']).

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/purge-cache" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "purgeAll": true
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "message": "Global cache successfully purged across all Edge nodes",
  "purgedPaths": [
    "*"
  ]
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Origin Bilgisini Al
GET /api/v1/sites/{id}/origin Scope: sites:read

Sitenin backend kaynak sunucu IP/Hostname adresini, bağlantı zaman aşımı değerlerini ve Origin Lock güvenlik kilidi durumunu döndürür.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Site ID Örnek: tahablt.com.tr

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/origin" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "origin": {
    "url": "https://85.235.75.211:443",
    "hostHeader": "tahablt.com.tr",
    "timeoutSec": 30,
    "originLockEnabled": true,
    "lockToken": "nx_lock_7a82b9c1",
    "healthCheck": {
      "status": "healthy",
      "httpCode": 200,
      "latencyMs": 18
    }
  }
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Origin Yapılandırmasını Güncelle
PUT /api/v1/sites/{id}/origin Scope: sites:write

Backend sunucu adresini, portunu veya Host başlığı iletim ayarlarını günceller.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Site ID Örnek: tahablt.com.tr

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
url string Zorunlu
Yeni origin hedef URL adresi.
hostHeader string Opsiyonel
Origin'e iletilecek özel Host başlığı (varsayılan: site domain).
timeoutSec integer Opsiyonel
Backend yanıt zaman aşımı süresi (saniye). Varsayılan: 30

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X PUT "https://shield.nexren.info/api/v1/sites/{id}/origin" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "url": "https://85.235.75.211:443",
  "timeoutSec": 30
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "message": "Origin server configuration updated successfully"
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Origin Lock Aç / Kapat
POST /api/v1/sites/{id}/origin/lock/toggle Scope: sites:write

Origin Lock özelliğini açıp kapatır. Origin Lock aktif olduğunda kaynak sunucunuz sadece Nexren Shield'ın gizli kriptografik anahtar başlığını içeren isteklere yanıt verir; doğrudan IP saldırılarını engeller.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Site ID Örnek: tahablt.com.tr

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
enabled boolean Zorunlu
Origin Lock korumasını aktifleştir (true) veya devre dışı bırak (false).

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/origin/lock/toggle" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "enabled": true
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "originLockEnabled": true,
  "lockHeader": "X-Nexren-Origin-Lock",
  "lockToken": "nx_lock_7a82b9c1d3e5",
  "instructions": "Configure your origin web server (Nginx/Apache) to require this header for incoming traffic."
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Politika Ayarlarını Al
GET /api/v1/policies/{id} Scope: policies:read

Sitenin aktif güvenlik politikasını, rate limiting eşiklerini, bot koruma duyarlılığını ve özel kural listesini getirir.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Politika ID Örnek: tahablt.com.tr

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/policies/{id}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "policy": {
    "id": "pol_88f2a1",
    "siteId": "site_9f81a7b2",
    "domain": "tahablt.com.tr",
    "mode": "Balanced",
    "rateLimitRps": 60,
    "challengeBotDDoS": true,
    "blockTorProxies": false,
    "geoBlocking": {
      "enabled": false,
      "blockedCountries": []
    },
    "customRulesCount": 4
  }
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Politika & WAF Kurallarını Güncelle
PUT /api/v1/policies/{id} Scope: policies:write

Siteye ait WAF ve hız kısıtlama eşiklerini, bot koruma mekanizmalarını veya ülke engelleme listelerini tek istekte günceller.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
Hedef domain adı (örn: 'tahablt.com.tr') veya Politika ID Örnek: tahablt.com.tr

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
rateLimitRps integer Opsiyonel
IP başına saniyelik maksimum istek sınırı.
challengeBotDDoS boolean Opsiyonel
Şüpheli bot trafiğine otomatik JS/CAPTCHA challenge uygula.
blockTorProxies boolean Opsiyonel
Tor çıkış düğümlerinden gelen istekleri engelle.

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X PUT "https://shield.nexren.info/api/v1/policies/{id}" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "rateLimitRps": 100,
  "challengeBotDDoS": true
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "message": "Security policy configuration updated successfully"
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Canlı Güvenlik Olayları & Saldırı Kayıtları
GET /api/v1/events Scope: events:read

WAF tarafından engellenen veya filtrelenen şüpheli istekleri, saldırgan IP adreslerini, tespit edilen kural eşleşmelerini ve zaman damgalarını sorgular.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Sorgu Parametreleri (Query Parameters)

URL sorgu dizgisi (query string) ile filtreleme seçenekleri.

ParametreTürDurumAçıklama & Seçenekler
siteId string Opsiyonel
Yalnızca belirli bir sitenin olaylarını getir (domain veya site ID).
action string Opsiyonel
Olay aksiyon türüne göre filtrele. Varsayılan: all
Seçenekler:
block challenge simulate all
limit integer Opsiyonel
Döndürülecek maksimum olay sayısı (1-200). Varsayılan: 50

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/events" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "events": [
    {
      "id": "evt_99182ab",
      "siteId": "site_9f81a7b2",
      "domain": "tahablt.com.tr",
      "timestamp": "2026-08-31T20:25:12Z",
      "clientIp": "203.0.113.45",
      "country": "DE",
      "method": "POST",
      "path": "/api/login",
      "action": "block",
      "reason": "SQL Injection payload detected in request body",
      "ruleId": "waf_sqli_core_01",
      "userAgent": "sqlmap/1.6#stable"
    }
  ],
  "total": 1
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

Trafik & Tehdit Analitiği Özeti
GET /api/v1/analytics/summary Scope: analytics:read

Son 24 saat veya belirtilen zaman aralığındaki toplam istek, engellenen saldırı, önbellek isabet oranı (cache hit ratio) ve ortalama yanıt gecikmesini döndürür.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Sorgu Parametreleri (Query Parameters)

URL sorgu dizgisi (query string) ile filtreleme seçenekleri.

ParametreTürDurumAçıklama & Seçenekler
siteId string Opsiyonel
Filtrelenecek domain adı veya site ID (belirtilmezse tüm siteler).
period string Opsiyonel
Zaman aralığı. Varsayılan: 24h
Seçenekler:
1h 24h 7d 30d

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/analytics/summary" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "period": "24h",
  "totalRequests": 482190,
  "cleanRequests": 468940,
  "blockedThreats": 13250,
  "cacheHitRate": "84.2%",
  "avgLatencyMs": 14.6,
  "topAttackedPaths": [
    {
      "path": "/api/v1/auth",
      "count": 7420
    },
    {
      "path": "/wp-login.php",
      "count": 3210
    }
  ]
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

API Tokenlarını Listele
GET /api/v1/tokens Scope: tokens:read

Hesabınıza ait aktif REST API anahtarlarını, yetki kapsamlarını (scopes), izin verilen IP kısıtlamalarını ve son kullanım tarihlerini döndürür.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/tokens" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "tokens": [
    {
      "id": "tok_8f92a10b",
      "name": "CI/CD Deployment Key",
      "prefix": "nx_live_8f92",
      "scopes": [
        "sites:read",
        "sites:write",
        "analytics:read"
      ],
      "ipWhitelist": [
        "198.51.100.0/24"
      ],
      "expiresAt": "2026-11-30T00:00:00Z",
      "createdAt": "2026-08-31T18:00:00Z",
      "lastUsedAt": "2026-08-31T20:10:00Z"
    }
  ]
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

Yeni API Tokenı Oluştur
POST /api/v1/tokens Scope: tokens:write

Yeni bir REST API erişim anahtarı üretir. Üretilen 'rawKey' (nx_live_...) güvenlik nedeniyle yalnızca bu istekte tek seferlik gösterilir.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY
Content-Type string Zorunlu
application/json Örnek: application/json

İstek Gövdesi Parametreleri (Request Body Payload)

JSON formatında gönderilecek istek gövdesi alanları ve veri türleri.

Alan (Field)Veri TürüDurumDetaylı Açıklama & Seçenekler
name string Zorunlu
Tokenın kullanım amacını belirten açıklayıcı isim.
scopes array Opsiyonel
Yetki kapsamları listesi (örn: ['sites:read', 'sites:write']). Boş bırakılırsa tüm yetkiler verilir.
expiresInDays integer Opsiyonel
Geçerlilik süresi (gün). Varsayılan: 30
Seçenekler:
7 30 90 365 0 (Never)
ipWhitelist array Opsiyonel
Yalnızca bu IP/CIDR adreslerinden gelen isteklere izin ver (Opsiyonel).

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X POST "https://shield.nexren.info/api/v1/tokens" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Terraform Automation Key",
  "scopes": [
    "sites:read",
    "sites:write",
    "analytics:read"
  ],
  "expiresInDays": 90
}'

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 201 Created application/json
{
  "success": true,
  "token": {
    "id": "tok_8f92a10b",
    "name": "Terraform Automation Key",
    "prefix": "nx_live_8f92",
    "rawKey": "nx_live_8f92a10bc39e44d5918274a1e902bc34",
    "scopes": [
      "sites:read",
      "sites:write",
      "analytics:read"
    ],
    "expiresAt": "2026-11-29T20:00:00Z"
  },
  "warning": "Make sure to copy your rawKey now. You won't be able to see it again!"
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

API Tokenını İptal Et / Sil
DEL /api/v1/tokens/{id} Scope: tokens:write

Belirtilen API Token anahtarını anında iptal eder. İptal edilen anahtarla yapılan tüm yeni istekler 401 Unauthorized döner.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Yol Parametreleri (Path Parameters)

URL yolu içerisinde iletilen dinamik kaynak değişkenleri.

ParametreTürDurumAçıklama
{id} string Zorunlu
İptal edilecek Token ID (tok_...) Örnek: tok_8f92a10b

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X DELETE "https://shield.nexren.info/api/v1/tokens/{id}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "success": true,
  "message": "API token tok_8f92a10b has been permanently revoked"
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.

{id} (Domain veya Site ID)
Aktif Token & Yetki Durumu
GET /api/v1/whoami Scope: whoami

İstekte kullanılan API Token anahtarının geçerliliğini, atanmış yetki kapsamlarını (scopes), istemci IP adresini ve güncel dakikalık rate limit durumunu doğrular.

İstek Başlıkları (Request Headers)

Uç noktaya iletilmesi gereken HTTP istek başlıkları.

Başlık (Header)TürDurumAçıklama
Authorization string Zorunlu
Bearer API Token Örnek: Bearer $NEXREN_API_KEY

Kod Örnekleri (Code Snippets)

Farklı programlama dillerinde kullanıma hazır örnek çağrılar.

curl -s -X GET "https://shield.nexren.info/api/v1/whoami" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Başarılı Yanıt Şeması (Response Preview)

Başarılı istek durumunda döndürülen JSON yanıt gövdesi.

HTTP 200 OK application/json
{
  "authenticated": true,
  "tokenId": "tok_8f92a10b",
  "tokenName": "CI/CD Deployment Key",
  "clientIp": "198.51.100.44",
  "scopes": [
    "sites:read",
    "sites:write",
    "analytics:read"
  ],
  "rateLimit": {
    "limit": 120,
    "remaining": 119,
    "reset": 1725142800
  }
}

Canlı Konsol (Try-It-Out Playground)

API uç noktasına anlık istek gönderip sunucu yanıtını test edin.