Saldırı koruması ayarlarını al

GET /v1/attack-protection · izin attack-protection:read

Ortamın saldırı koruması nesnesini döndürür: kaba kuvvet, şüpheli IP kısıtlaması, kimlik bilgisi doldurma, bot koruması, sızmış parola, kayıt koruması, SMS koruması ve risk politikası. Her bölümün iki görünümü vardır: configured sizin yazdığınız değerdir, effective ise yürürlükteki değerdir; varsayılanlar, güvenlik tabanı ve planınız uygulanmış hâlidir. Hiç yazmadığınız bir bölümün değeri configured: {} olur. ETag yanıt başlığı nesnenin içeriğini belirler; PUT ve PATCH isteklerinde If-Match olarak gönderin.

İstek

Bu işlemin yol, sorgu ya da gövde alanı yoktur. Ortam kimlik bilgisinden belirlenir.

Yanıt

200 OK ile nesne ve ETag başlığı.

{
  "schema_version": 1,
  "brute_force": {
    "configured": {"max_failures": 10},
    "effective": {"mode": "enforce", "max_failures": 10, "window_minutes": 15, "lock_minutes": 15, "notify_user": true}
  },
  "risk_policy": {
    "configured": {"mode": "enforce"},
    "effective": {"mode": "log", "challenge_threshold": 4, "block_threshold": null, "notify_user_on_new_device": true}
  },
  "bot_protection": {
    "configured": {},
    "effective": {"mode": "risk_based", "provider": "altcha"}
  }
}

Örnek kısaltılmıştır: her yanıt sekiz bölümün tamamını içerir (brute_force, suspicious_ip_throttling, credential_stuffing, bot_protection, breached_password, signup_protection, sms_protection, risk_policy). Örnekte plan artık risk zorlamasını içermediği için yazdığınız enforce değeri korunur, ancak log olarak görünür.

Alanlar

Alan	Tür	Aralık veya değerler	Varsayılan	Taban
`brute_force.mode`	metin	`log`, `enforce`	`enforce`
`brute_force.max_failures`	tam sayı	5-100	20	en fazla 100
`brute_force.window_minutes`	tam sayı	5-60	15
`brute_force.lock_minutes`	tam sayı	5-60	15	en az 5
`brute_force.notify_user`	mantıksal		`true`
`suspicious_ip_throttling.mode`	metin	`log`, `enforce`	`enforce`
`suspicious_ip_throttling.login_failures_per_ip_per_day`	tam sayı	10-10000	100
`suspicious_ip_throttling.signups_per_ip_per_hour`	tam sayı	1-20	20	en fazla 20
`suspicious_ip_throttling.allowlist`	metin dizisi	en fazla 100 CIDR öneki; IPv4 için /8'den, IPv6 için /32'den geniş olamaz	`[]`
`credential_stuffing.mode`	metin	`log`, `enforce`	`enforce`
`credential_stuffing.attack_mode_auto`	mantıksal		`true`
`credential_stuffing.attack_mode_duration_minutes`	tam sayı	15-240	30
`bot_protection.mode`	metin	`off`, `risk_based`, `always`	`risk_based`
`bot_protection.provider`	metin	`altcha`	`altcha`
`breached_password.on_signup`	metin	`block`	`block`	`block`
`breached_password.on_password_change`	metin	`block`	`block`	`block`
`breached_password.on_login`	metin	`require_reset`, `notify`	`require_reset`
`breached_password.notify_user`	mantıksal		`true`
`signup_protection.block_disposable_email`	mantıksal		`true`
`signup_protection.block_email_subaddress`	mantıksal		`false`
`signup_protection.max_signups_per_device_30d`	tam sayı	1-50	3
`sms_protection.allowed_countries`	metin dizisi	en fazla 250 ISO 3166-1 alpha-2 kodu	`[]` (plan varsayılanı)
`sms_protection.daily_cap`	tam sayı \| null	1-1000000; `null` plan değeridir	`null`
`sms_protection.conversion_breaker`	mantıksal		`true`	`true`
`risk_policy.mode`	metin	`log`, `enforce` (`enforce` için Startup veya üstü plan gerekir)	`log`
`risk_policy.challenge_threshold`	tam sayı	3-8	4
`risk_policy.block_threshold`	tam sayı \| null	6-12, `challenge_threshold` değerinden büyük; `null` kapalıdır	`null`
`risk_policy.notify_user_on_new_device`	mantıksal		`true`

Hatalar

HTTP	kod	Ne zaman
401	`unauthenticated`	Kimlik bilgisi eksik, geçersiz ya da iptal edilmiş.
403	`insufficient_permissions`	Kimlik bilgisinde gerekli izin yok.
429	`rate_limited`	Hız sınırı aşıldı; `Retry-After` süresinden sonra yeniden deneyin.
503	`service_unavailable`	Bir bağımlılık geçici olarak kullanılamıyor; `Retry-After` süresinden sonra yeniden deneyin.

Örnek

curl https://api.eu.keenauth.com/v1/attack-protection \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"