NEXREN SHIELD REST API v1.0 Dokümantasyonu

Nexren Shield REST API Yüksek performanslı DDoS koruması, akıllı WAF kuralları, Origin Lock ve gerçek zamanlı güvenlik analitiği için modern REST API mimarisi.

Hızlı Başlangıç (Quickstart)

3 adımda Nexren Shield API ile ilk isteğinizi gönderin.

1 API Tokenınızı Alın

Müşteri paneliniz üzerinden gerekli yetki kapsamlarına (scopes) sahip bir API Token (nx_live_...) oluşturun.

Müşteri Paneli →

2 İlk İsteği Gönderin

Authorization: Bearer <token> başlığı ile token geçerliliğinizi ve yetkilerinizi test edin.

Token Test Et (/whoami) →

3 Siteleri & Korumayı Yönetin

Sitelerinizi ekleyin, Origin Lock kalkanını açın, önbelleğinizi temizleyin ve saldırı kayıtlarını anlık izleyin.

Siteleri Listele →

Temel 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

Yeni Site Ekle (POST /v1/sites) Kimlik Doğrulama Rehberi → Hız Sınırları 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ı (Tokens) sekmesinden oluşturabilirsiniz.

HTTP Authorization Header Örneği

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

API Tokenı Al (Müşteri Paneli) → 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ü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ı & 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 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ı.

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

const res = await fetch("https://shield.nexren.info/api/v1/sites", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/sites",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/sites", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "domain": "example.com",
  "originUrl": "https://198.51.100.25:443",
  "mode": "Balanced"
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.post(
    "https://shield.nexren.info/api/v1/sites",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "domain": "example.com",
  "originUrl": "https://198.51.100.25:443",
  "mode": "Balanced"
}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "domain": "example.com",
  "originUrl": "https://198.51.100.25:443",
  "mode": "Balanced"
}`)
	req, _ := http.NewRequest("POST", "https://shield.nexren.info/api/v1/sites", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/sites/{id}",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/sites/{id}", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}", {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "mode": "Under Attack"
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.patch(
    "https://shield.nexren.info/api/v1/sites/{id}",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "mode": "Under Attack"
}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "mode": "Under Attack"
}`)
	req, _ := http.NewRequest("PATCH", "https://shield.nexren.info/api/v1/sites/{id}", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.delete(
    "https://shield.nexren.info/api/v1/sites/{id}",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://shield.nexren.info/api/v1/sites/{id}", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}/purge-cache", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "purgeAll": true
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.post(
    "https://shield.nexren.info/api/v1/sites/{id}/purge-cache",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "purgeAll": True
}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "purgeAll": true
}`)
	req, _ := http.NewRequest("POST", "https://shield.nexren.info/api/v1/sites/{id}/purge-cache", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}/origin", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/sites/{id}/origin",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/sites/{id}/origin", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}/origin", {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "url": "https://198.51.100.25:443",
  "timeoutSec": 30
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.put(
    "https://shield.nexren.info/api/v1/sites/{id}/origin",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "url": "https://198.51.100.25:443",
  "timeoutSec": 30
}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "url": "https://198.51.100.25:443",
  "timeoutSec": 30
}`)
	req, _ := http.NewRequest("PUT", "https://shield.nexren.info/api/v1/sites/{id}/origin", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/sites/{id}/origin/lock/toggle", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "enabled": true
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.post(
    "https://shield.nexren.info/api/v1/sites/{id}/origin/lock/toggle",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "enabled": True
}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "enabled": true
}`)
	req, _ := http.NewRequest("POST", "https://shield.nexren.info/api/v1/sites/{id}/origin/lock/toggle", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/policies/{id}", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/policies/{id}",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/policies/{id}", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/policies/{id}", {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "rateLimitRps": 100,
  "challengeBotDDoS": true
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.put(
    "https://shield.nexren.info/api/v1/policies/{id}",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "rateLimitRps": 100,
  "challengeBotDDoS": True
}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "rateLimitRps": 100,
  "challengeBotDDoS": true
}`)
	req, _ := http.NewRequest("PUT", "https://shield.nexren.info/api/v1/policies/{id}", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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

const res = await fetch("https://shield.nexren.info/api/v1/events", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/events",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/events", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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)

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"

const res = await fetch("https://shield.nexren.info/api/v1/analytics/summary", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/analytics/summary",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/analytics/summary", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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ık	Tür	Durum
`Authorization`	string	Zorunlu

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

const res = await fetch("https://shield.nexren.info/api/v1/whoami", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`
  }
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.get(
    "https://shield.nexren.info/api/v1/whoami",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"}
)
print(res.json())

package main

import (
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://shield.nexren.info/api/v1/whoami", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

Hızlı Başlangıç (Quickstart)

Temel API Modülleri & Yetenekler

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

HTTP Durum Kodları Kataloğu

Web Siteleri Yönetimi (Sites)

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

Sorgu Parametreleri

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

İstek Gövdesi

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

Yol Parametreleri

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

Yol Parametreleri

İstek Gövdesi

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

Yol Parametreleri

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

Yol Parametreleri

İstek Gövdesi

Origin & Origin Lock (Kaynak Sunucu Güvenliği)

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

Yol Parametreleri

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

Yol Parametreleri

İstek Gövdesi

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

Yol Parametreleri

İstek Gövdesi

Güvenlik Politikaları & WAF

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

Yol Parametreleri

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

Yol Parametreleri

İstek Gövdesi

Güvenlik Günlükleri & Analitik

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

Sorgu Parametreleri

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

Sorgu Parametreleri

Kimlik & Token Durumu (Identity)

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