Get instance settings | Clerk API (unofficial showcase)

1 status code

200Returns the instance object with its identifier, environment type, allowed origins, subdomain settings, and owning workspace ID.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:instance

idstringrequired

environment_typestringrequired

allowed_originsarray<string>required

allowed_subdomainsarray<string>required

Subdomains of the instance's own domains that may originate requests, when the subdomain allowlist is enabled. Production instances only; always empty on a development instance.

subdomain_allowlist_enabledbooleanrequired

Whether requests from subdomains of the instance's own domains are restricted to `allowed_subdomains`. When false, every subdomain of the instance's domain is accepted. Production instances only; always false on a development instance.

workspace_idstringrequired

The ID of the Clerk workspace that owns the instance's application. It is null when the application has no owner.

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.instance.list();

{
  "object": "instance",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "environment_type": "development",
  "allowed_origins": [
    "http://localhost:3000",
    "https://some-domain"
  ],
  "allowed_subdomains": [
    "app.example.com",
    "*.preview.example.com"
  ],
  "subdomain_allowlist_enabled": true,
  "workspace_id": "org_2abc123def456"
}

Response