Get instance Protect settings | Clerk API (unofficial showcase)

1 status code

200Returns the instance Protect object with rule enforcement, Device Intelligence, and prerequisite check status.

objectstringrequired

Allowed:instance_protect

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.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.protect.list();

{
  "object": "instance_protect",
  "rules_enabled": true,
  "specter_enabled": true,
  "checks_bypassed": true,
  "checks_verified": true,
  "checks_exempt": true
}