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:

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, CDN yönlendirmelerini yönetin ve global edge önbelleğinizi anında 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 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.

Web Sitelerini Listele

GET /api/v1/sites Scope: sites:read
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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

İ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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
}'

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
}'

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

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)

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"

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
AI & LLM EXPORT
IDE & MCP INTEGRATION

İ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"