connections

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

Switch a protected domain between monitor, block and off.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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.

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`domainId (path)`	`string`	هو	The provider's id for the protected domain.

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`mode`	`string<monitor, block, off>`	هو	⛔ `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.

ځواب

نوم	ډول	اړین	دا څه شی دی
`id`	`string`	هو	—
`domain`	`string`	هو	—
`mode`	`string<monitor, block, off, locked>`	هو	⛔⛔ `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`	نه	—
`total_requests`	`integer`	نه	⛔ `null` when the provider does not report it — never `0`.
`blocked_requests`	`integer`	نه	⛔ `null` when unknown. "Nothing was blocked" and "we cannot see what was blocked" are opposite answers and must not render alike.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 422 · 429

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