connections
POST /v1/waap/domains/{domainId}/mode
Switch a protected domain between monitor, block and off.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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>> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
domainId (path) | string | Ano | The provider's id for the protected domain. |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
mode | string<monitor, block, off> | Ano | ⛔ 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. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
domain | string | Ano | — |
mode | string<monitor, block, off, locked> | Ano | ⛔⛔ 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 | Ne | — |
total_requests | integer | Ne | ⛔ null when the provider does not report it — never 0. |
blocked_requests | integer | Ne | ⛔ null when unknown. "Nothing was blocked" and "we cannot see what was blocked" are opposite answers and must not render alike. |
Chyby, které může tento koncový bod vrátit
401 · 422 · 429