List all instance domains | Clerk API (unofficial showcase)

1 status code

200A list of domains

dataarray<object>required

total_countintegerrequired

Total number of domains

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

{
  "data": [
    {
      "object": "domain",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "is_satellite": true,
      "frontend_api_url": "https://example.com",
      "accounts_portal_url": "https://example.com",
      "proxy_url": "https://example.com",
      "development_origin": "example_value",
      "cname_targets": [
        {
          "host": "example_value",
          "value": "example_value",
          "required": true
        }
      ],
      "dns_targets": [
        {
          "host": "example_value",
          "value": "example_value",
          "record_type": "CNAME",
          "automation_disposition": "already_satisfied",
          "required": true
        }
      ]
    }
  ],
  "total_count": 42
}

Response