connections

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

Switch a protected domain between monitor, block and off.

પ્રમાણીકરણ

બિયરર ટૉકન તરીકે API કી મોકલો. આ એન્ડપૉઇન્ટ સ્પેશિફિકેશનમાં કોઈ ચોક્કસ પરવાનગી જણાવતું નથી, તેથી ધારણા બાંધવાને બદલે તમારી કીને તેની જરૂરિયાત મુજબ ન્યૂનતમ પરવાનગી આપો અને રિસ્પોન્સ તપાસો.

આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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 કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ API સામે વિનંતી ચલાવે છે જેથી તમે વાસ્તવિક પ્રતિસાદ જોઈ શકો. આ અંતિમબિંદુને 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