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ı (Tokens) sekmesinden oluşturabilirsiniz.
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ür | Açıklama |
|---|---|---|
X-RateLimit-Limit | integer | Dakikalık toplam istek kotanız (120). |
X-RateLimit-Remaining | integer | Mevcut pencerede kalan istek hakkınız. |
X-RateLimit-Reset | timestamp | Kotanın sıfırlanacağı Unix epoch saniyesi. |
HTTP Durum Kodları Kataloğu
Olası HTTP yanıt kodları, anlamları ve geliştirici çözüm yolları.
| HTTP Kodu | Durum | Açıklama & Çözüm |
|---|---|---|
200 OK | Başarılı | İstek başarıyla işlendi ve beklenen veri nesnesi döndürüldü. |
201 Created | Oluşturuldu | Yeni 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 Request | Hatalı İstek | Eksik parametre, hatalı JSON sözdizimi veya doğrulanamayan payload formatı. İstek gövdesini kontrol edin. |
401 Unauthorized | Yetkisiz | API Token anahtarı eksik, geçersiz veya süresi dolmuş. Authorization: Bearer nx_live_... başlığını doğrulayın. |
403 Forbidden | Yasaklandı | Kullanılan API Token'ının yetki kapsamı (Scope) bu işlem için yetersiz veya IP kısıtlaması uyuşmuyor. |
404 Not Found | Bulunamadı | 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ışma | Eklenmek istenen domain veya kaynak sistemde zaten kayıtlı. |
429 Too Many Requests | Hız Sınırı Aşıldı | Dakikalık 120 istek kotası aşıldı. X-RateLimit-Reset süresini bekleyin. |
500 Internal Error | Sunucu Hatası | Sunucu tarafında beklenmeyen bir hata meydana geldi. |
502 Bad Gateway | Geçersiz Ağ Geçidi | Origin sunucunuza ulaşılamadı veya bağlantı zaman aşımına uğradı. |
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Sorgu Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
includePending |
boolean | Opsiyonel |
search |
string | Opsiyonel |
curl -s -X GET "https://shield.nexren.info/api/v1/sites" \
-H "Authorization: Bearer $NEXREN_API_KEY"
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Content-Type |
string | Zorunlu |
İstek Gövdesi
| Alan | Tür | Durum |
|---|---|---|
domain |
string | Zorunlu |
originUrl |
string | Zorunlu |
mode |
string | Opsiyonel |
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"
}'
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}" \
-H "Authorization: Bearer $NEXREN_API_KEY"
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Content-Type |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
İstek Gövdesi
| Alan | Tür | Durum |
|---|---|---|
mode |
string | Opsiyonel |
originUrl |
string | Opsiyonel |
enabled |
boolean | Opsiyonel |
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 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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
curl -s -X DELETE "https://shield.nexren.info/api/v1/sites/{id}" \
-H "Authorization: Bearer $NEXREN_API_KEY"
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Content-Type |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
İstek Gövdesi
| Alan | Tür | Durum |
|---|---|---|
purgeAll |
boolean | Opsiyonel |
paths |
array | Opsiyonel |
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
}'
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
curl -s -X GET "https://shield.nexren.info/api/v1/sites/{id}/origin" \
-H "Authorization: Bearer $NEXREN_API_KEY"
Backend sunucu adresini, portunu veya Host başlığı iletim ayarlarını günceller.
İstek Başlıkları (Request Headers)
| Başlık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Content-Type |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
İstek Gövdesi
| Alan | Tür | Durum |
|---|---|---|
url |
string | Zorunlu |
hostHeader |
string | Opsiyonel |
timeoutSec |
integer | Opsiyonel |
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 ö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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Content-Type |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
İstek Gövdesi
| Alan | Tür | Durum |
|---|---|---|
enabled |
boolean | Zorunlu |
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
}'
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
curl -s -X GET "https://shield.nexren.info/api/v1/policies/{id}" \
-H "Authorization: Bearer $NEXREN_API_KEY"
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Content-Type |
string | Zorunlu |
Yol Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
{id} |
string | Zorunlu |
İstek Gövdesi
| Alan | Tür | Durum |
|---|---|---|
rateLimitRps |
integer | Opsiyonel |
challengeBotDDoS |
boolean | Opsiyonel |
blockTorProxies |
boolean | Opsiyonel |
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 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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Sorgu Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
siteId |
string | Opsiyonel |
action |
string | Opsiyonel |
limit |
integer | Opsiyonel |
curl -s -X GET "https://shield.nexren.info/api/v1/events" \
-H "Authorization: Bearer $NEXREN_API_KEY"
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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
Sorgu Parametreleri
| Parametre | Tür | Durum |
|---|---|---|
siteId |
string | Opsiyonel |
period |
string | Opsiyonel |
curl -s -X GET "https://shield.nexren.info/api/v1/analytics/summary" \
-H "Authorization: Bearer $NEXREN_API_KEY"
İ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ık | Tür | Durum |
|---|---|---|
Authorization |
string | Zorunlu |
curl -s -X GET "https://shield.nexren.info/api/v1/whoami" \
-H "Authorization: Bearer $NEXREN_API_KEY"