Instance Settings

Update instance protect settings

Changed on
patch/instance/protect

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/instance/protect
  • Auth: HTTP bearer

Request body

rules_enabledboolean nullable

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.

Response

Success

object'instance_protect' required
rules_enabledboolean required

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_enabledboolean required

Whether Device Intelligence is enabled. Managed automatically or by Clerk support.

checks_bypassedboolean required

Whether the instance has opted out of the Protect prerequisite checks, asserting its setup already meets the requirements.

checks_verifiedboolean required

Whether the Protect system has verified the instance's prerequisite checks. Protect rules are gated on checks being verified, bypassed or exempt.

checks_exemptboolean required

Whether the instance was created into Protect and so was never subject to the prerequisite checks at all.

Changes

  • 2025-11-107db12d6a9b2aRevision changes
    • warning

      removed the request property

    • info

      the response required property became read-only for the status

  • 2025-11-10b5f30169c3f3Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status