NEXREN SHIELD REST API v1.0 Dokümantasyonu

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ü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 ID veya ada 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)

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

Başlık (Header)	Tür	Durum	Açı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.

Parametre	Tür	Durum	Açı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"

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

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": "api.example.com",
      "originUrl": "https://198.51.100.25: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.

Sonraki: Yeni Web Sitesi Ekle

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ür	Durum	Açı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ü	Durum	Detaylı Açıklama & Seçenekler
`domain`	string	Zorunlu	Korumaya alınacak tam alan adı veya alt alan adı (örn: 'app.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": "api.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": "api.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": "api.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": "api.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)
}

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": "api.example.com",
    "originUrl": "https://198.51.100.25: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.

İstek Gövdesi (JSON Payload Body):

Önceki: Web Sitelerini Listele Sonraki: Web Sitesi Detayları

Web Sitesi Detayları

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

Belirtilen ID veya domain adına 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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Site ID (site_...) veya tam alan adı Örnek: `site_9f81a7b2`

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"

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

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": "api.example.com",
    "originUrl": "https://198.51.100.25: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.

Yol Parametreleri (Path Variables):

{id}

Önceki: Yeni Web Sitesi Ekle Sonraki: Site Ayarlarını Güncelle

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Hedef Web Sitesi ID veya domain adı Örnek: `site_9f81a7b2`

İ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ü	Durum	Detaylı Açıklama & Seçenekler
`mode`	string	Opsiyonel	Yeni koruma modu. 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"
}'

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

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": "api.example.com",
    "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.

Yol Parametreleri (Path Variables):

{id}

İstek Gövdesi (JSON Payload Body):

Önceki: Web Sitesi Detayları Sonraki: Web Sitesini Sil

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Silinecek site ID veya domain adı Örnek: `site_9f81a7b2`

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"

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

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 api.example.com 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.

Yol Parametreleri (Path Variables):

{id}

Önceki: Site Ayarlarını Güncelle Sonraki: Önbelleği Temizle (Purge Cache)

Ö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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Hedef site ID veya domain adı Örnek: `site_9f81a7b2`

İ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ü	Durum	Detaylı 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
}'

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

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.

Yol Parametreleri (Path Variables):

{id}

İstek Gövdesi (JSON Payload Body):

Önceki: Web Sitesini Sil Sonraki: Origin Bilgisini Al

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Site ID veya domain adı Örnek: `site_9f81a7b2`

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"

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

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://198.51.100.25:443",
    "hostHeader": "api.example.com",
    "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.

Yol Parametreleri (Path Variables):

{id}

Önceki: Önbelleği Temizle (Purge Cache) Sonraki: Origin Yapılandırmasını Güncelle

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Site ID veya domain adı Örnek: `site_9f81a7b2`

İ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ü	Durum	Detaylı 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://198.51.100.35: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.35: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.35:443",
  "timeoutSec": 30
}
)
print(res.json())

package main

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

func main() {
	body := strings.NewReader(`{
  "url": "https://198.51.100.35: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)
}

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.

Yol Parametreleri (Path Variables):

{id}

İstek Gövdesi (JSON Payload Body):

Önceki: Origin Bilgisini Al Sonraki: Origin Lock Aç / Kapat

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Site ID veya domain adı Örnek: `site_9f81a7b2`

İ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ü	Durum	Detaylı 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
}'

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

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.

Yol Parametreleri (Path Variables):

{id}

İstek Gövdesi (JSON Payload Body):

Önceki: Origin Yapılandırmasını Güncelle Sonraki: Politika Ayarlarını Al

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Site ID veya Politika ID Örnek: `site_9f81a7b2`

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"

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

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",
    "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.

Yol Parametreleri (Path Variables):

{id}

Önceki: Origin Lock Aç / Kapat Sonraki: Politika & WAF Kurallarını Güncelle

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama
`{id}`	string	Zorunlu	Site ID veya Politika ID Örnek: `site_9f81a7b2`

İ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ü	Durum	Detaylı 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
}'

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

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.

Yol Parametreleri (Path Variables):

{id}

İstek Gövdesi (JSON Payload Body):

Önceki: Politika Ayarlarını Al Sonraki: Canlı Güvenlik Olayları & Saldırı Kayıtları

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama & Seçenekler
`siteId`	string	Opsiyonel	Yalnızca belirli bir sitenin olaylarını getir.
`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"

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

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": "api.example.com",
      "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.

Önceki: Politika & WAF Kurallarını Güncelle Sonraki: Trafik & Tehdit Analitiği Özeti

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açıklama & Seçenekler
`siteId`	string	Opsiyonel	Filtrelenecek 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"

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

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.

Önceki: Canlı Güvenlik Olayları & Saldırı Kayıtları Sonraki: API Tokenlarını Listele

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ür	Durum	Açı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"

const res = await fetch("https://shield.nexren.info/api/v1/tokens", {
  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/tokens",
    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/tokens", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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.

Önceki: Trafik & Tehdit Analitiği Özeti Sonraki: Yeni API Tokenı Oluştur

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ür	Durum	Açı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ü	Durum	Detaylı 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
}'

const res = await fetch("https://shield.nexren.info/api/v1/tokens", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.NEXREN_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "Terraform Automation Key",
  "scopes": [
    "sites:read",
    "sites:write",
    "analytics:read"
  ],
  "expiresInDays": 90
})
});
const data = await res.json();
console.log(data);

import os, requests
res = requests.post(
    "https://shield.nexren.info/api/v1/tokens",
    headers={"Authorization": f"Bearer {os.getenv('NEXREN_API_KEY')}"},
    json={
  "name": "Terraform Automation Key",
  "scopes": [
    "sites:read",
    "sites:write",
    "analytics:read"
  ],
  "expiresInDays": 90
}
)
print(res.json())

package main

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

func main() {
	body := strings.NewReader(`{
  "name": "Terraform Automation Key",
  "scopes": [
    "sites:read",
    "sites:write",
    "analytics:read"
  ],
  "expiresInDays": 90
}`)
	req, _ := http.NewRequest("POST", "https://shield.nexren.info/api/v1/tokens", 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)
}

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.

İstek Gövdesi (JSON Payload Body):

Önceki: API Tokenlarını Listele Sonraki: API Tokenını İptal Et / Sil

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ür	Durum	Açı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.

Parametre	Tür	Durum	Açı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"

const res = await fetch("https://shield.nexren.info/api/v1/tokens/{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/tokens/{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/tokens/{id}", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NEXREN_API_KEY"))
	resp, _ := http.DefaultClient.Do(req)
	fmt.Println(resp.Status)
}

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.

Yol Parametreleri (Path Variables):

{id}

Önceki: Yeni API Tokenı Oluştur Sonraki: Aktif Token & Yetki Durumu

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ür	Durum	Açı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"

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

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.

Önceki: API Tokenını İptal Et / Sil