connections

POST `/v1/waap/domains/{domainId}/mode`

Switch a protected domain between monitor, block and off.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

curl -X POST https://api.zinndigital.com/v1/waap/domains/{domainId}/mode \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "mode": <string<monitor, block, off>> }'

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

The one call here that changes whether traffic is refused. ⛔ The response reports the mode the provider says is **now in force**, which is not necessarily the one that was requested: providers apply some transitions asynchronously and refuse others outright. Echoing the request back would leave every screen showing a protection state that was never applied. ⛔ `locked` is rejected with `422`: it is a state the provider assigns, never one that can be requested, and accepting it would build a control that always fails.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`domainId (path)`	`string`	Evet	The provider's id for the protected domain.

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`mode`	`string<monitor, block, off>`	Evet	⛔ `locked` is absent on purpose: it is a state the provider assigns, never one that can be requested, and the API answers `422` for it.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`string`	Evet	—
`domain`	`string`	Evet	—
`mode`	`string<monitor, block, off, locked>`	Evet	⛔⛔ `monitor` logs every match and delivers the traffic anyway. It produces analytics and blocks nothing, and on a dashboard it is indistinguishable from `block` unless this…
`created_at`	`string`	Hayır	—
`total_requests`	`integer`	Hayır	⛔ `null` when the provider does not report it — never `0`.
`blocked_requests`	`integer`	Hayır	⛔ `null` when unknown. "Nothing was blocked" and "we cannot see what was blocked" are opposite answers and must not render alike.

Bu uç noktanın dönderebileceği hatalar

401 · 422 · 429

POST /v1/waap/domains/{domainId}/mode