PATCH
/instance/protectUpdate instance Protect settings
Updates whether Protect rules are enforced for the instance. Set rules_enabled to true to enforce rules or false to return to shadow evaluation, which continues scoring and recording rules without blocking traffic.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Instance Protect settings to update. All fields are optional.
rules_enabledbooleanoptional
Set true to enforce Protect rules on this instance. Set false to stop enforcing and return the instance to its default posture, where traffic is still evaluated in shadow but nothing is blocked. This does not remove the instance from Protect.
200Returns the instance Protect object with the rule enforcement setting, Device Intelligence status, and prerequisite check status.
objectstringrequired
rules_enabledbooleanrequired
Whether Protect rules are enforced on this instance. False does not mean the instance is outside Protect — by default it is still evaluated in shadow, where rules are scored and recorded but never block.
specter_enabledbooleanrequired
Whether Device Intelligence is enabled. Managed automatically or by Clerk support.
checks_bypassedbooleanrequired
Whether the instance has opted out of the Protect prerequisite checks, asserting its setup already meets the requirements.
checks_verifiedbooleanrequired
Whether the Protect system has verified the instance's prerequisite checks. Protect rules are gated on checks being verified, bypassed or exempt.
checks_exemptbooleanrequired
Whether the instance was created into Protect and so was never subject to the prerequisite checks at all.
422Returned when the supplied Protect setting is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
Error handling
A 422 is returned when the supplied setting is invalid. If provided, rules_enabled must be a boolean.