Nexren Shield API v1.0

API Metotları ve Endpoint'ler

Nexren Shield Cloud Edge Security & WAF mimarisi için kapsamlı REST API referansı. Tüm HTTP istekleri JSON formatında kabul edilir ve Bearer Token ile yetkilendirilir.

Base URL: https://shield.nexren.info/api/v1
Download OpenAPI description
OpenAPI 3.1.0 standardındaki makine tarafından okunabilir API şeması.

Languages

Gönderilecek isteklerde varsayılan olarak görüntülenecek programlama dilini seçin:

AI Agent & LLM Entegrasyonu

Cursor, Claude Code, Antigravity, Windsurf veya ChatGPT için hazır ajan kurulum talimatını tek tıkla kopyalayın.

Core API Modülleri & Yetenekler

Kullanım senaryolarına göre ayrıştırılmış REST v1 servisleri.

Web Siteleri

Alan adlarınızı ekleyin, kenar yönlendirmelerini yönetin ve kenar statik dosya önbelleğinizi temizleyin.

GET / POST / PATCH / DELETE / PURGE
Origin & Koruma

Kaynak sunucunuzun IP adresini gizleyin ve doğrudan saldırılara karşı kilit mekanizmasını yönetin.

GET / PUT / LOCK TOGGLE
Politikalar & WAF

DDoS koruma seviyesini ayarlayın, SQLi / XSS saldırı kurallarını ve IP bazlı erişim listelerini yönetin.

GET / PUT / POLICIES
Olaylar & Analitik

WAF katmanında engellenen gerçek zamanlı tehdit loglarını ve 24 saatlik trafik metriklerini sorgulayın.

GET /v1/events & GET /v1/analytics/summary
Kimlik & Profil

İstekte kullanılan token'ın geçerliliğini, kalan hız sınırı kotasını ve aktif scope izinlerini sorgulayın.

GET /v1/whoami
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 hesabınızda 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.

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)

BaşlıkTürDurum
Authorization string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
includePending boolean Opsiyonel
search string Opsiyonel
GET /api/v1/sites
curl -s -X GET "https://shield.nexren.info/api/v1/sites" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

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)

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

İstek Gövdesi

AlanTürDurum
domain string Zorunlu
originUrl string Zorunlu
mode string Opsiyonel
POST /api/v1/sites
curl -s -X POST "https://shield.nexren.info/api/v1/sites" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "domain": "example.com",
  "originUrl": "https://198.51.100.25:443",
  "mode": "Balanced"
}'

Web Sitesi Detayları

GET /api/v1/sites/{id} Scope: sites:read

Belirtilen domain adı (örn: 'example.com') 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)

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

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)

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
mode string Opsiyonel
originUrl string Opsiyonel
enabled boolean Opsiyonel
PATCH /api/v1/sites/{id}
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"
}'

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)

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

Önbelleği Temizle (Purge Cache)

POST /api/v1/sites/{id}/purge-cache Scope: sites:write

Sitenin kenar statik dosya önbelleğini temizler (tümü ya da verilen yollar; sondaki * önek eşleşmesidir). Kenarda en geç ~1 sn içinde etkili olur. Yanıttaki kayıt/bayt sayıları gerçektir: kenarın son raporundaki (en çok ~30 sn eski, an countsAsOf) önbellek içeriği. Sayı bilinmiyorsa (rapor yok, rapor önceki temizlemeden eski, ya da yol kapsamında eşleşme sayısı raporlanmıyor) entries/bytes/purgedSize null, countsExact false olur ve neden countsUnknownReason'da yazar — asla uydurma 0 dönmez. Tüm site YALNIZ {"purgeAll": true} (paths olmadan) ya da boş gövde / {} ile temizlenir. Geçersiz gövde 400 döner ve hiçbir şey temizlenmez: bozuk JSON, null ya da nesne olmayan gövde, tanınmayan alan (ör. "path"), null / dizi olmayan / boş paths, yol olarak '*' ya da '/*' (purgeAll:true kullanın), boolean olmayan purgeAll (null dahil), purgeAll:true ile birlikte paths ya da purgeAll:false ile yol verilmemesi.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
purgeAll boolean Opsiyonel
paths array Opsiyonel
POST /api/v1/sites/{id}/purge-cache
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
}'

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 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)

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

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)

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
url string Zorunlu
hostHeader string Opsiyonel
timeoutSec integer Opsiyonel
PUT /api/v1/sites/{id}/origin
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://198.51.100.25:443",
  "timeoutSec": 30
}'

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)

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
enabled boolean Zorunlu
POST /api/v1/sites/{id}/origin/lock/toggle
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
}'

Origin Lock Sunucu Kod Parçacıkları

GET /api/v1/sites/{id}/origin/lock/snippets Scope: sites:read

Nginx, Apache, PHP (WordPress), Caddy, Cloudflare Custom Rules, UFW ve Iptables için sitenize özel kriptografik başlık ve gizli anahtarla hazır kopyala-yapıştır koruma yapılandırmalarını döndürür.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
GET /api/v1/sites/{id}/origin/lock/snippets
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/origin/lock/snippets" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Origin Lock Canlı Doğrulama

POST /api/v1/sites/{id}/origin/lock/verify Scope: sites:write

Kaynak sunucunuzun doğrudan IP bağlantılarını reddettiğini ve yalnızca Nexren Shield kriptografik imzalı istekleri kabul ettiğini test eder ve kalkanı kilitler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
POST /api/v1/sites/{id}/origin/lock/verify
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/origin/lock/verify" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

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.

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)

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

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)

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
rateLimitRps integer Opsiyonel
challengeBotDDoS boolean Opsiyonel
blockTorProxies boolean Opsiyonel
PUT /api/v1/policies/{id}
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
}'

WAF İstisnalarını Listele

GET /api/v1/sites/{id}/waf/exceptions Scope: policies:read

Belirli WAF kurallarını sadece belirli URL yollarında ve HTTP metotlarında esneten kural istisnalarını satır biçiminde getirir. v4.10.231'den beri istisnalar özel kural olarak saklanır (eylem skip + wafRules); bu uç onların satır görünümüdür.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
GET /api/v1/sites/{id}/waf/exceptions
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/waf/exceptions" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

WAF İstisnalarını Güncelle

PUT /api/v1/sites/{id}/waf/exceptions Scope: policies:write

Satır satır formatta (<ruleId> <path> [methods]) WAF istisnalarını özel kural olarak kaydeder (diğer özel kurallar korunur; «Kurallar ve IP listeleri» düzenleme izni — rules:edit). Tüm siteyi kapsayan istisnalar (/* veya /) güvenlik gereği reddedilir.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
raw string Zorunlu
PUT /api/v1/sites/{id}/waf/exceptions
curl -s -X PUT "https://shield.nexren.info/api/v1/sites/{id}/waf/exceptions" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "raw": "930120 /api/upload POST\n941100 /admin/* *"
}'

Kural İstisnasını Sil

DEL /api/v1/sites/{id}/waf/exceptions/{ruleId} Scope: policies:write

Belirtilen kural ID'sini sitenin tüm kapsamlı istisnalarından (wafRules taşıyan özel kurallar) kaldırır.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
{ruleId} string Zorunlu
DEL /api/v1/sites/{id}/waf/exceptions/{ruleId}
curl -s -X DELETE "https://shield.nexren.info/api/v1/sites/{id}/waf/exceptions/{ruleId}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

İstisna Sözdizimini Doğrula

POST /api/v1/sites/{id}/waf/exceptions/validate Scope: policies:read

WAF istisna kurallarını kaydetmeden önce sözdizimi ve güvenlik kontrolünden geçirir.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
raw string Zorunlu
POST /api/v1/sites/{id}/waf/exceptions/validate
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/waf/exceptions/validate" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "raw": "930120 /api/upload POST"
}'

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ı 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)

BaşlıkTürDurum
Authorization string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
siteId string Opsiyonel
action string Opsiyonel
limit integer Opsiyonel
GET /api/v1/events
curl -s -X GET "https://shield.nexren.info/api/v1/events" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Trafik & Tehdit Analitiği Özeti

GET /api/v1/analytics/summary Scope: analytics:read

İstek sayılarını (izin verilen, engellenen, doğrulamaya yönlendirilen, hız limitine takılan), tahmini bant genişliğini ve kenar önbelleği isabet oranını döndürür. cachedRatio gerçek bir ölçümdür: kenar süreçlerinin raporladığı isabet ÷ (isabet + ıska), süreç başlangıcından beri; önbelleğe uygun hiç istek yoksa null.

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

BaşlıkTürDurum
Authorization string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
siteId string Opsiyonel
period string Opsiyonel
GET /api/v1/analytics/summary
curl -s -X GET "https://shield.nexren.info/api/v1/analytics/summary" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Nexren Tunnels (Güvenli Tünel Bağlantıları)

Scope: tunnels:*, sites:*

Kaynak sunucunuzda hiçbir gelen port (inbound port 80/443) açmadan, Nexren Cloud Edge ağına giden şifreli QUIC/WebSocket ters tüneli kurun.

Sitenin Tünellerini Listele

GET /api/v1/sites/{id}/tunnels Scope: tunnels:read

Siteye tanımlanmış tüm ters origin tünellerini, canlı bağlantı durumlarını, agent sürümlerini ve anlık gecikmelerini listeler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

Yeni Nexren Tüneli Başlat

POST /api/v1/sites/{id}/tunnels Scope: tunnels:write

Yeni bir ters tünel kaydı oluşturur ve origin sunucunuzda nexren-agent çalıştırmanız için güvenli token anahtarı üretir.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
name string Zorunlu
localTarget string Opsiyonel
POST /api/v1/sites/{id}/tunnels
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/tunnels" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "App Server 1",
  "localTarget": "http://127.0.0.1:3000"
}'

Tünel Durumunu Al

GET /api/v1/sites/{id}/tunnels/{tunnelId} Scope: tunnels:read

Belirtilen tünelin bağlantı geçmişini, canlı akış sayısını ve ping gecikmesini getirir.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
{tunnelId} string Zorunlu
GET /api/v1/sites/{id}/tunnels/{tunnelId}
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/tunnels/{tunnelId}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Tüneli İptal Et (Revoke)

DEL /api/v1/sites/{id}/tunnels/{tunnelId} Scope: tunnels:write

Tüneli anında kapatır ve yetki anahtarını kalıcı olarak iptal eder.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
{tunnelId} string Zorunlu
DEL /api/v1/sites/{id}/tunnels/{tunnelId}
curl -s -X DELETE "https://shield.nexren.info/api/v1/sites/{id}/tunnels/{tunnelId}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Origin İletim Modunu Değiştir

POST /api/v1/sites/{id}/origin-kind Scope: sites:write

Sitenin gelen istekleri doğrudan IP/URL origin sunucusuna mı ('direct') yoksa bağlı Nexren Tüneline mi ('tunnel') ileteceğini belirler.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
originKind string Zorunlu
POST /api/v1/sites/{id}/origin-kind
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/origin-kind" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "originKind": "tunnel"
}'

Tüm Tünelleri Listele

GET /api/v1/tunnels Scope: tunnels:read

Hesabınıza bağlı tüm sitelerin tünellerini tek listede gösterir.

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

BaşlıkTürDurum
Authorization string Zorunlu
GET /api/v1/tunnels
curl -s -X GET "https://shield.nexren.info/api/v1/tunnels" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

DDoS Savunması & Hız Sınırları (Rate Limiting)

Scope: policies:*

Katman 7 flood ve volumetrik DDoS saldırılarına karşı akıllı rate limit eşiklerini, burst toleransını ve acil durum korumasını yapılandırın.

DDoS & Hız Sınırlarını Al

GET /api/v1/sites/{id}/ddos Scope: policies:read

Sitenin dakikalık/saniyelik rate limit kotalarını, burst eşiğini, bot challenge durumunu ve DDoS koruma seviyesini getirir.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

DDoS & Hız Sınırlarını Güncelle

PUT /api/v1/sites/{id}/ddos Scope: policies:write

RPS limitini, burst kapasitesini ve bot koruma eşiğini tek çağrıda günceller.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
rateLimitRps integer Opsiyonel
rateLimitBurst integer Opsiyonel
ddosSensitivity string Opsiyonel
PUT /api/v1/sites/{id}/ddos
curl -s -X PUT "https://shield.nexren.info/api/v1/sites/{id}/ddos" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "rateLimitRps": 100,
  "rateLimitBurst": 150,
  "ddosSensitivity": "high"
}'

Acil DDoS Savunmasını Başlat

POST /api/v1/sites/{id}/ddos/mitigate Scope: policies:write

Siteyi anında 'Under Attack' acil durum moduna geçirir ve tüm gelen istekleri JS PoW / CAPTCHA ile filtreler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
POST /api/v1/sites/{id}/ddos/mitigate
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/ddos/mitigate" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Rate Limit Sayaçlarını Sıfırla

POST /api/v1/sites/{id}/ddos/reset Scope: policies:write

Siteye bağlı sliding-window rate limit sayaçlarını ve geçici IP kısıtlama tablolarını sıfırlar.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
POST /api/v1/sites/{id}/ddos/reset
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/ddos/reset" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Bakım Modu (Maintenance Mode)

Scope: policies:*

Web sitenizi tek tıkla veya API çağrısıyla özel tasarlanmış HTML bakım sayfasına alın; geliştirici ve şirket IP'lerini kısıtlamadan muaf tutun.

Bakım Modu Yapılandırmasını Al

GET /api/v1/sites/{id}/maintenance Scope: policies:read

Sitenin bakım modunda olup olmadığını, özel HTML şablonunu, tahmini bitiş zamanını (ETA) ve muaf tutulan IP listesini döndürür.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

Bakım Modu Ayarlarını Güncelle

PUT /api/v1/sites/{id}/maintenance Scope: policies:write

Bakım sayfasının HTML kodunu, muaf IP'leri, HTTP durum kodunu (503) ve aktifliğini ayarlar.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
enabled boolean Opsiyonel
customHtml string Opsiyonel
bypassIps array Opsiyonel
eta string Opsiyonel
PUT /api/v1/sites/{id}/maintenance
curl -s -X PUT "https://shield.nexren.info/api/v1/sites/{id}/maintenance" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "enabled": true,
  "customHtml": "<h1>Bakım Çalışması</h1>",
  "bypassIps": [
    "198.51.100.5"
  ]
}'

Bakım Modunu Hızlı Aç / Kapat

POST /api/v1/sites/{id}/maintenance/toggle Scope: policies:write

Tek bir POST isteği ile bakım modunu anında açar veya kapatır.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

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

Bakım Sayfasını Önizle

GET /api/v1/sites/{id}/maintenance/preview Scope: policies:read

Ziyaretçilere sunulacak bakım sayfası HTML tasarımını tarayıcıda önizler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
GET /api/v1/sites/{id}/maintenance/preview
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/maintenance/preview" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Zero Trust Güvenli Erişim (Zero Trust Access)

Scope: zt:*

Hassas yönetim panelleri ve dahili API yollarını TOTP 2FA, kurumsal e-posta doğrulama ve IP kısıtlamalarıyla koruyun.

Zero Trust Erişim Kurallarını Listele

GET /api/v1/sites/{id}/zt/access-rules Scope: zt:read

Site için tanımlanmış yol bazlı kimlik doğrulama, TOTP 2FA ve IP kısıtlama kurallarını listeler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
GET /api/v1/sites/{id}/zt/access-rules
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/zt/access-rules" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Zero Trust Erişim Kuralı Oluştur

POST /api/v1/sites/{id}/zt/access-rules Scope: zt:write

Belirli bir URL yolu için TOTP 2FA veya IP bazlı erişim zorunluluğu tanımlar.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
name string Zorunlu
pathPattern string Zorunlu
require2fa boolean Opsiyonel
POST /api/v1/sites/{id}/zt/access-rules
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/zt/access-rules" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Admin Panel",
  "pathPattern": "/admin/*",
  "require2fa": true
}'

Zero Trust Erişim Kuralını Sil

DEL /api/v1/sites/{id}/zt/access-rules/{ruleId} Scope: zt:write

Zero Trust erişim kuralını kalıcı olarak siler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
{ruleId} string Zorunlu
DEL /api/v1/sites/{id}/zt/access-rules/{ruleId}
curl -s -X DELETE "https://shield.nexren.info/api/v1/sites/{id}/zt/access-rules/{ruleId}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Zero Trust 2FA TOTP Doğrulaması

POST /api/v1/sites/{id}/zt/users/{userId}/verify-2fa Scope: zt:write

Kullanıcının kimlik doğrulayıcı uygulamasından girdiği 6 haneli TOTP kodunu doğrular.

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

BaşlıkTürDurum
Authorization string Zorunlu
Content-Type string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
{userId} string Zorunlu

İstek Gövdesi

AlanTürDurum
token string Zorunlu
POST /api/v1/sites/{id}/zt/users/{userId}/verify-2fa
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/zt/users/{userId}/verify-2fa" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "token": "123456"
}'

Aktif Zero Trust Oturumlarını Listele

GET /api/v1/sites/{id}/zt/sessions Scope: zt:read

Sitede kimliği doğrulanmış aktif personelin oturumlarını ve zaman aşımı sürelerini gösterir.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu
GET /api/v1/sites/{id}/zt/sessions
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/zt/sessions" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Zero Trust Oturumlarını İptal Et

POST /api/v1/sites/{id}/zt/sessions/revoke Scope: zt:write

Belirli bir kullanıcının veya tüm personelin aktif oturumlarını tek çağrıyla sonlandırır.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

İstek Gövdesi

AlanTürDurum
email string Opsiyonel
POST /api/v1/sites/{id}/zt/sessions/revoke
curl -s -X POST "https://shield.nexren.info/api/v1/sites/{id}/zt/sessions/revoke" \
     -H "Authorization: Bearer $NEXREN_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
  "email": "user@example.com"
}'

Tehdit Akışı & Saldırı Olayları (Threat Intelligence)

Scope: threats:read, events:read

Edge kalkanı tarafından engellenen gerçek zamanlı saldırı akışını, coğrafi kökenleri ve kaydedilen DDoS olaylarını izleyin.

Site DDoS Olaylarını Listele

GET /api/v1/sites/{id}/incidents Scope: events:read

Siteye yönelik kaydedilen volumetrik ve Layer 7 flood saldırı olaylarının başlangıç, bitiş, tepe RPS ve engelleme raporlarını döndürür.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

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

Tüm Hesap DDoS Olaylarını Listele

GET /api/v1/incidents Scope: events:read

Hesabınıza bağlı tüm siteler genelindeki DDoS saldırı kayıtlarını listeler.

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

BaşlıkTürDurum
Authorization string Zorunlu
GET /api/v1/incidents
curl -s -X GET "https://shield.nexren.info/api/v1/incidents" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Gerçek Zamanlı Engellenen Tehdit Akışı

GET /api/v1/threats/live Scope: events:read

Edge düğümlerinde engellenen saldırıların canlı akışını, gizlenmiş istemci IP'lerini, ülkelerini ve tetiklenen WAF kurallarını döndürür.

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

BaşlıkTürDurum
Authorization string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
siteId string Opsiyonel
limit integer Opsiyonel
GET /api/v1/threats/live
curl -s -X GET "https://shield.nexren.info/api/v1/threats/live" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Tehdit Kategorisi Analiz Özeti

GET /api/v1/threats/summary Scope: analytics:read

Engellenen saldırıların kategorilerine (SQLi, XSS, RCE, Bot, DDoS vb.) göre sayısal ve yüzdesel dağılımını özetler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
siteId string Opsiyonel
period string Opsiyonel
GET /api/v1/threats/summary
curl -s -X GET "https://shield.nexren.info/api/v1/threats/summary" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Güvenlik & Sistem Denetim Günlükleri (Audit Logs)

Scope: audit:read

Hesabınızda gerçekleştirilen tüm yapılandırma değişikliklerini, API anahtarı işlemlerini ve kural güncellemelerini denetleyin.

Site Güvenlik Denetim Kayıtları

GET /api/v1/sites/{id}/audit-logs Scope: audit:read

Sitede gerçekleştirilen kural değişiklikleri, SSL yenilemeleri, mod güncellemeleri ve API çağrılarının denetim izini listeler.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{id} string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
limit integer Opsiyonel
GET /api/v1/sites/{id}/audit-logs
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/audit-logs" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Hesap Genel Denetim Kayıtları

GET /api/v1/audit-logs Scope: audit:read

Hesap genelinde gerçekleştirilen tüm işlemlerin zaman damgalı, aktör ve IP kayıtlı denetim geçmişini getirir.

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

BaşlıkTürDurum
Authorization string Zorunlu

Sorgu Parametreleri

ParametreTürDurum
category string Opsiyonel
search string Opsiyonel
GET /api/v1/audit-logs
curl -s -X GET "https://shield.nexren.info/api/v1/audit-logs" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

Tekil Denetim Kaydı Detayını Al

GET /api/v1/audit-logs/{logId} Scope: audit:read

Belirtilen denetim kaydının aktör, IP, istek parametreleri ve durum detaylarını gösterir.

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

BaşlıkTürDurum
Authorization string Zorunlu

Yol Parametreleri

ParametreTürDurum
{logId} string Zorunlu
GET /api/v1/audit-logs/{logId}
curl -s -X GET "https://shield.nexren.info/api/v1/audit-logs/{logId}" \
     -H "Authorization: Bearer $NEXREN_API_KEY"

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.

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)

BaşlıkTürDurum
Authorization string Zorunlu
GET /api/v1/whoami
curl -s -X GET "https://shield.nexren.info/api/v1/whoami" \
     -H "Authorization: Bearer $NEXREN_API_KEY"